Skip to content

Commit

Permalink
doc: wording
Browse files Browse the repository at this point in the history
  • Loading branch information
pierrecamilleri committed Jan 21, 2025
1 parent 9d7becd commit 0987349
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit 0987349

Please sign in to comment.