Skip to content

Commit e9f6146

Browse files
Add CONTRIBUTING.md document (#198)
1 parent 6e75306 commit e9f6146

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# How to contribute to the Exercism {{LANGUAGE}} track
2+
3+
#### **Do you want to add an exercise?**
4+
5+
- **Ensure that someone else isn't already adding it** by searching the [forum](https://forum.exercism.org/c/programming/{{SLUG}}) and the repository's [issues](https://github.com/exercism/{{SLUG}}/issues) and [pull requests](https://github.com/exercism/{{SLUG}}/pulls).
6+
7+
- If nobody is yet adding the exercise, [open a conversation](https://forum.exercism.org/c/programming/{{SLUG}}) and indicate you'd like to add the exercise.
8+
9+
- Follow the [Add a Practice Exercise docs](https://exercism.org/docs/building/tracks/practice-exercises/add).
10+
11+
#### **Do you want to report a bug?**
12+
13+
- **Ensure the bug was not already reported** by searching the [forum](https://forum.exercism.org/c/programming/{{SLUG}}).
14+
15+
- If you're unable to find an open conversation addressing the problem, [open a new one](https://forum.exercism.org/new-topic?category={{SLUG}}). Be sure to include a **title and clear description**, as much relevant information as possible, and (when possible) a **code sample**.
16+
17+
#### **Do you want to fix a bug?**
18+
19+
- **Ensure that the bug is [reported](#do-you-want-to-report-a-bug)**.
20+
Only start fixing the bug when there is agreement on whether (and how) it should be fixed.
21+
22+
- Fix the bug and [submit a Pull Request](https://exercism.org/docs/building/github/contributors-pull-request-guide) to this repository.
23+
24+
- Ensure the PR description clearly describes the problem and solution.
25+
Include a link to the bug's corresponding forum conversation.
26+
27+
- Before submitting, please read the [Contributors Pull Request Guide](https://exercism.org/docs/building/github/contributors-pull-request-guide) and [Pull Request Guide](https://exercism.org/docs/community/being-a-good-community-member/pull-requests).
28+
29+
#### **Do you intend to add a new feature or change an existing one?**
30+
31+
- **Ensure that the feature or change is discussed on the [forum](https://forum.exercism.org/c/programming/{{SLUG}}).**
32+
Only start adding the feature or change when there is agreement on whether (and how) it should be added or changed.
33+
34+
- Add the feature or change and [submit a Pull Request](https://exercism.org/docs/building/github/contributors-pull-request-guide) to this repository.
35+
36+
- Ensure the PR description clearly describes the problem and solution.
37+
Include a link to the bug's corresponding forum conversation.
38+
39+
- Before submitting, please read the [Contributors Pull Request Guide](https://exercism.org/docs/building/github/contributors-pull-request-guide) and [Pull Request Guide](https://exercism.org/docs/community/being-a-good-community-member/pull-requests).

bin/bootstrap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ end
7575
"config.json",
7676
"README.md",
7777
"CHECKLIST.md",
78+
"CONTRIBUTING.md",
7879
File.join("bin", "verify-exercises-in-docker"),
7980
File.join("docs", "config.json")
8081
].each do |name|

0 commit comments

Comments
 (0)