diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b56c88..9892cf4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ > First off, thank you for considering contributing to this project. -> It’s [people like you](ref-contributors) that keep this project alive and make it great! +> It’s [people like you][ref-contributors] that keep this project alive and make it great! > Thank you! πŸ™πŸ’œπŸŽ‰πŸ‘ The following is a set of guidelines for contributing this project. @@ -11,12 +11,12 @@ Use your best judgment, and feel free to propose changes to this document in a p When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change. - + ### 🐞 You found a bug or have an issue? -1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](ref-issues). -2. Create a [new issue](ref-issues-new) with a **clear and descriptive title** +1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. +2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** 3. Write a **detailed comment** with as much relevant information as possible including - *how to reproduce* the bug - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring @@ -24,10 +24,10 @@ When contributing to this repository, please first discuss the change you wish t ### 🩹 You wrote a patch that fixes an issue? -1. Open a [new pull request (PR)](ref-pull-request-new) with the patch. +1. Open a [new pull request (PR)][ref-pull-request-new] with the patch. 2. Ensure the PR description clearly describes the problem and solution. -3. Link the relevant **issue** if applicable ([how to link issues in PRs](ref-pull-request-how-to)). -4. Ensure that [**no tests are failing**](ref-gh-actions) and **coding conventions** are held +3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]). +4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are held 5. Submit the patch and await review. ### πŸ†• You want to add a new feature? @@ -35,6 +35,7 @@ When contributing to this repository, please first discuss the change you wish t +[ref-code-of-conduct]: t.b.d. [ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors [ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions [ref-issues-new]: https://github.com/fireblade-engine/ecs/issues/new/choose