Skip to content

Commit 33cc66c

Browse files
committed
[CHANGE] Added contributing guide
1 parent 5f669bc commit 33cc66c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing code
2+
3+
This repository is a collection of dev container Features managed by [Markus Zhang].
4+
This repository will **only accept improvements and
5+
bug fixes** for the [current set of maintained Features].
6+
7+
If you're looking to create a new Feature, then we encourage adding it to a
8+
separate repository of your control. The [devcontainers/feature-starter]
9+
repository has more guidance on self authoring Features.
10+
11+
Once you've self authored the Features and if you'd like to share them with
12+
the community, then I'd recommend [adding it to the index].
13+
14+
If you've identified an issue and you want to fix it, here's how you can get
15+
started:
16+
17+
1. Fork the repo
18+
2. Open the repo in your editor
19+
3. Add your changes to your workspace
20+
4. Add additional tests to your workspace if neccessary
21+
5. Test your changes using `bin/test <feature name>` to make sure everything still works
22+
6. Bump the version of the feature you changed according to [semver]
23+
7. Commit & push your changes
24+
8. Open a PR to get your changes merged
25+
26+
[Markus Zhang]: https://github.com/RouL
27+
[current set of maintained Features]: https://github.com/RouL/devcontainer-features/tree/main/src
28+
[devcontainers/feature-starter]: https://github.com/devcontainers/feature-starter#readme
29+
[adding it to the index]: https://github.com/devcontainers/feature-starter#adding-features-to-the-index
30+
[semver]: https://semver.org/

0 commit comments

Comments
 (0)