* Create CONTRIBUTING.md * Direct questions to slack channel Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com> * Use "dev containers" and "Features" Apparently devcontainers is two words, and apparently features is a proper noun? I guess 🤷♂️ * Prettier formatting I used https://prettier.io/playground/ since I was editing in the GitHub web editor * Clarify to "only accept improvements and bug fixes" Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Be more explicit about custom features Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Add link to CLI test docs * Add semver step in guide * More specificity in link text https://github.com/devcontainers/features/pull/488#discussion_r1137819187 * Add CONTRIBUTING.md link in readme --------- Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com> Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com>
2.9 KiB
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 test
to 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.