Contribution¶
Contribution to this project is welcome! However, it must follow the code of conduct for the project.
Ways to Contribute¶
File bug reports and feature requests in the issue tracker. (Please try to avoid duplicate issues.)
Fork the repository and submit pull requests to improve the source code or documentation. Pull requests should follow the development guidance and standards below.
Development¶
Guidance and Standards¶
Follow the development environment preparation and management instructions to ensure consistency with maintainer development environments and CI workflows.
Adhere to the development practices and code style to improve the probability of pull request acceptance. You may wish to use an LLM to assist with this, if the standards seem too onerous or specific.
Also consider the nomenclature advice for consistency and to improve the probability of pull request acceptance.
Prepare changelog fragments according to the releases guide as appropriate.
Although unncessary for non-maintainer contributions, additional background can be found in the maintenance guide.
Artificial Intelligence¶
Contributions, which are co-authored by large language models (LLMs), are welcome, provided that they adhere to the project guidance and standards above and are, otherwise, of good quality.
A more compact representation of the above guidance and standards, plus some other advice for these models, can be found in
.auxiliary/configuration/conventions.md
. You may link to this file from aAGENTS.md
,CLAUDE.md
,CONVENTIONS.md
file in the root of the project. These files are ignored by Git as we do not wish to pollute the root of the project with them in the upstream repository.
Artificial Intelligence¶
Contributions, which are co-authored by large language models (LLMs), are welcome, provided that they adhere to the project guidance and standards above and are, otherwise, of good quality.
A more compact representation of the above guidance and standards, plus some other advice for these models, can be found in
.auxiliary/configuration/conventions.md
. You may link to this file from aAGENTS.md
,CLAUDE.md
,CONVENTIONS.md
file in the root of the project. These files are ignored by Git as we do not wish to pollute the root of the project with them in the upstream repository.