Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md document #198

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# How to contribute to the Exercism {{LANGUAGE}} track

#### **Do you want to add an exercise?**

- **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).

- 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.

- Follow the [Add a Practice Exercise docs](https://exercism.org/docs/building/tracks/practice-exercises/add).

#### **Do you want to report a bug?**

- **Ensure the bug was not already reported** by searching the [forum](https://forum.exercism.org/c/programming/{{SLUG}}).

- 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**.

#### **Do you want to fix a bug?**

- **Ensure that the bug is [reported](#do-you-want-to-report-a-bug)**.
Only start fixing the bug when there is agreement on whether (and how) it should be fixed.

- Fix the bug and [submit a Pull Request](https://exercism.org/docs/building/github/contributors-pull-request-guide) to this repository.

- Ensure the PR description clearly describes the problem and solution.
Include a link to the bug's corresponding forum conversation.

- 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).

#### **Do you intend to add a new feature or change an existing one?**

- **Ensure that the feature or change is discussed on the [forum](https://forum.exercism.org/c/programming/{{SLUG}}).**
Only start adding the feature or change when there is agreement on whether (and how) it should be added or changed.

- Add the feature or change and [submit a Pull Request](https://exercism.org/docs/building/github/contributors-pull-request-guide) to this repository.

- Ensure the PR description clearly describes the problem and solution.
Include a link to the bug's corresponding forum conversation.

- 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).
1 change: 1 addition & 0 deletions bin/bootstrap
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ end
"config.json",
"README.md",
"CHECKLIST.md",
"CONTRIBUTING.md",
File.join("bin", "verify-exercises-in-docker"),
File.join("docs", "config.json")
].each do |name|
Expand Down