From 0987349e1f2ff9b6e61c2be1765272c3b4cdd1eb Mon Sep 17 00:00:00 2001 From: Pierre Camilleri Date: Tue, 21 Jan 2025 10:48:14 +0100 Subject: [PATCH] doc: wording --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efbcda2..4453dc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,11 @@ Thank you for taking the time to contribute to the `fr-format` project! Your hel ## How to Contribute ? -We welcome all forms of contributions,they are highly encouraged: +We welcome all forms of contributions: -* Submitting Pull Requests (Enhancing code, Improving or adding documentation) * Reporting Issues or suggesting improvements +* Improving or adding documentation +* Enhancing code In all cases, ensure you are working with the latest version of the project. @@ -31,6 +32,12 @@ If you want to propose a new format, please verify: See the [specific section](#implementing-a-new-french-format) below for guidelines on implementing a new format. +## Improving and adding documentation + +All documentation files are located in [docs folder](./docs).\ +If your changes include complex logic or functionality, add clear and concise doc comments to explain them. +Also, if you identify areas for improvement in the documentation, please contribute! + ## Enhancing code ### Project setup and code style guidelines @@ -58,12 +65,6 @@ After verification, these are the steps to add it: 4. Import the format inside `./src/frformat/__init__` and add it to the `all_formats` list. 5. Run `make generate-docs` to update the format documentation. -## Improving and adding documentation - -All documentation files are located in [docs folder](./docs).\ -If your changes include complex logic or functionality, add clear and concise doc comments to explain them. -Also, if you identify areas for improvement in the documentation, please contribute! - ## License By contributing to `fr-format`, you agree that your contributions will be licensed under the project's [open-source license](./LICENSE.md).