Contributing to sphinxcontrib-rust

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued.

See the Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don’t have time to contribute, that’s fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project

  • Share it online

  • Refer this project in your project’s readme

  • Mention the project at local meetups and tell your friends/colleagues

Questions

Please read the documentation on readthedocs or Gitlab Pages before asking the question.

If the documentation does not cover it, search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.

  • Provide as much context as you can about what you’re running into.

  • Provide the project, Sphinx, Python and Rust versions and also the OS used.

We will then take care of the issue as soon as possible.

Contribute

This project is licensed as GNU GPL v3.0 or later. Please ensure all contributions are your original work or otherwise compliant with the license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report.

Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.

  • Ensure that the issue can be reliably reproduced.

  • Collect information about the bug:

    • Stack traces

    • Sphinx log for the build

    • Sphinx configuration and usage

    • Python, Rust and Sphinx versions

    • OS, Platform and Version

We use GitLab issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.

  • Explain the behavior you would expect and the actual behavior.

  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.

  • Provide the information you collected in the previous section.

Once it’s filed:

  • The project team will label the issue accordingly.

  • A team member will try to reproduce the issue with your provided steps.

    If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.

  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be prioritized for addressing.

  • If you have a potential fix for the issue, please also open a MR referencing the issue.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for sphinxcontrib-rust, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting

  • Check the Gitlab issues for any open issues that might cover the situtation.

Submitting suggestions

Enhancement suggestions are tracked as GitLab issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.

  • Provide a step-by-step description of the suggested enhancement in as many details as possible.

  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.

  • You may want to include screenshots or expected output which help you demonstrate the steps or point out the part which the suggestion is related to.

  • Explain why this enhancement would be useful to most sphinxcontrib-rust users.

Styleguides

Rust

A rustfmt.toml file is included with project for the Rust code style. Make sure to execute cargo +nightly fmt before submitting the MR. The CI will verify the code style and fail if it does not conform.

The CI will also run cargo +nightly clippy on the Rust crate and expect a success return code from it. Please address any new issues detected by clippy, even if the CI passes.

Python

The project uses black for formating the Python code. Make sure to run black . before submitting the MR.

The CI will also run pylint on the code. The .pylintrc to use is included in the project repository.

Commit Messages

Please create meaningful commit messages in the MR. You will be asked to edit the commit message if the maintainers feel so. The general format of the commit message should be

Brief description of the MR's goals

A detailed description of the why and how of the changes
in the MR. This can be as long as you like.

closes #<issue>

Join The Project Team

The project requires a good understanding of Sphinx and how it works.

It also uses both Rust and Python, so you must be able to review other people’s code in both languages. Familiarize yourself with the project’s organization and developer notes using Developer Documentation.

Attribution

This guide is based on the contributing-gen. Make your own!