Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (47 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.03 KB

Contributing Guidelines

Thank you for taking the time to contribute to the fr-format project! Your help is greatly appreciated.

How to Contribute ?

We welcome all forms of contributions:

  • Reporting issues or suggesting improvements
  • Improving and adding documentation
  • Enhancing code

In all cases, ensure you are working with the latest version of the project.

For more details, follow the sections below.

Reporting issues or suggesting improvements

If you encounter a bug or have a suggestion, please:

  1. Check if the issue already exists in the Github Issues section.
  2. Provide a detailed issue report is very appreciated!
    Including:
    - A clear description of the problem or suggestion.
    - Steps to reproduce the bug (if applicable).
    - Any relevant logs or screenshots.

If you want to propose a new format, please verify:

  1. that it does not already exists in the list of available formats
  2. that the new format is relevant. The scope of fr-format is exclusively specifically French formats.

See the specific section below for guidelines on implementing a new format.

Improving and adding documentation

All documentation files are located in docs folder.
Also, if you identify areas for improvement in the documentation, please contribute!

Enhancing code

Project setup and code style guidelines

See the developper documentation for details on how to setup the project, and the code style guidelines.

Adding features or fixing bugs

  1. Create a fork of the repository.
  2. Implement your changes and test them :
    • Run uv run pytest to execute tests.
    • Use uv run ruff check --select I --fix && uv run ruff format to ensure your code follows the project's style guidelines.
  3. Document your changes:
    • Provide a clear explanation in your pull request description.
    • Add comments to your code if necessary.
    • If your changes include new features, please document them in the "./docs" folder. New formats' documentation are automatically generated (see below).
  4. Finally, submit your pull request.

Implementing a new French format

After verification, these are the steps to add it:

  1. Create a new file in frformat/formats to implement the format validation logic. The most generic format interface is CustomFormat, but look out for helper functions (e.g. in set_format.py) for specific cases. (You can take examples from the existing code.)
  2. Write tests for it!
  3. Fix Linting problems running uv run ruff check --select I --fix && uv run ruff format.
  4. Import the format inside ./frformat/__init__ and add it to the all_formats list.
  5. Run uv run python .utils/generate_docs.py to update the format documentation.

License

By contributing to fr-format, you agree that your contributions will be licensed under the project's open-source license.

Thank you for your contribution!