Commit message requirtement added

overhangio · Dec 29, 2023 · d42d118 · d42d118
1 parent a89f31e
commit d42d118
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/tutor.rst b/docs/tutor.rst
@@ -101,12 +101,12 @@ Contributing to Tutor
 Contributions to Tutor and its plugins are highly encouraged. Please adhere to the following guidelines:
 
 - **General Discussion**: Before addressing anything other than clear-cut bugs, start a discussion on the `official Open edX forum <https://discuss.openedx.org>`__. This facilitates reaching a consensus on a high-level solution.
-- **Pull Requests**: For changes to Tutor core or plugin-specific modifications, open a pull request on the `Tutor repository <https://github.com/overhangio/tutor/pulls>`__.
+- **Pull Requests**: For changes to Tutor core or plugin-specific modifications, open a pull request on the `Tutor repository <https://github.com/overhangio/tutor/pulls>`__ or the corresponding plugin repository.
 - **Running Tests and Code Formatting**:
   - Ensure all tests pass by running ``make test``. This is mandatory for both Tutor core and plugin contributions.
   - If formatting tests fail, correct your code format using ``make format``.
 - **Changelog Entry**: Create a changelog entry for significant changes (excluding reformatting or documentation) by running ``make changelog-entry``. Edit the newly created file following the given formatting instructions. This applies to both Tutor core and plugin changes.
-- **Commit Messages**: Write clear Git commit titles and messages. Detail the rationale for your changes, the issue being addressed, and your solution. Include links to relevant forum discussions and describe your use case. Detailed explanations are valuable. For commit titles, follow `conventional commits <https://www.conventionalcommits.org>`__ guidelines.
+- **Commit Messages**: Write clear Git commit titles and messages. Detail the rationale for your changes, the issue being addressed, and your solution. Include links to relevant forum discussions and describe your use case. Detailed explanations are valuable. For commit titles, follow `conventional commits <https://www.conventionalcommits.org>`__ guidelines.Additionally, if your pull request addresses an existing GitHub issue, include 'Close #XXX' in your commit message, where XXX is the issue number.
 
 Releasing a new version
 -----------------------