From e9f6146dff85a7e07cfda4ed617f1d8eebd13e85 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Wed, 4 Dec 2024 09:41:11 +0100 Subject: [PATCH] Add CONTRIBUTING.md document (#198) --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ bin/bootstrap | 1 + 2 files changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2bedc56 --- /dev/null +++ b/CONTRIBUTING.md @@ -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). diff --git a/bin/bootstrap b/bin/bootstrap index 3c3a37f..193b858 100755 --- a/bin/bootstrap +++ b/bin/bootstrap @@ -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|