CONTRIBUTING.md
March 23, 2023 ยท View on GitHub
Thanks for taking the time to contribute! โค๏ธ
All types of contributions are encouraged and valued, no matter if it's a bug report ๐, a feature request ๐ก, or a Pull Request ๐.
- โ I have a question: Ask in our dev container community Slack channel
- ๐ I found a bug: Open an Issue
- ๐ก I have an idea: Open an Issue
- ๐ป I want to code: See below
If you like the project, but just don't have time to contribute, that's OK too! You can also star the project โญ, rave about it online ๐ฌ, or add a link to us ๐ in your project's readme.
โ ๏ธ You must never report security ๐ related issues, vulnerabilities or bugs
including sensitive information to the issue tracker, or elsewhere in public.
Instead, please report them to the Microsoft Security Response Center. You can
read more about our security policy in SECURITY.md.
Contributing code
๐จโ๐ผ This repository is a collection of dev container Features managed by dev container spec maintainers. This repository will only accept improvements and bug fixes for the current set of maintained Features.
๐ If you're looking to create a new Feature, then we encourage adding it to a separate repository of your control. The devcontainers/feature-starter repository has more guidance on self authoring Features.
๐ก Once you've self authored the Features and if you'd like to share them with the community, then we'd recommend adding it to the index.
๐ทโ If you've identified an issue and you want to fix it, here's how you can get started:
- ๐ Fork the repo
- ๐ป Open the repo in your editor
- ๐จโ๐ป Add your changes to your workspace
- โจ Test your changes using
devcontainer features testto make sure everything still works - ๐ Bump the version of the feature you changed according to semver
- ๐ Commit & push your changes
- ๐ Open a PR to get your changes merged
- ๐ Profit!
๐ฉโโ๏ธ When contributing code to this project, you may be asked to agree to our Contributor License Agreement.