Contributor's documentation

[szabo137]

Here we collect ideas for sections to be written for the contributor's documentation.

General purpose

The contribution guide has two main goals:

• to state the common practice on contributions for QED.jl for all, internal and external, contributors
• To teach new contributors about the different contribution paths available for QED.jl

Suggested structure The contribution guide should at least have the following sections

• code of conduct
• Get in contact
• Documentation guide
• File an issue
• Code contribution

Included topics

• [ ] advanced installation instructions
• [ ] how-to contribute (git, issues, forks, pull requests)
• [ ] code style guidelines + formatter
• [ ] debugging guide
• [ ] documentation style (docstrings, divio system)
• [ ] review guidelines
• [ ] CI guide
• [ ] API references
• [ ] design patterns
• [ ] testing (how-to write good unit/integration tests, add dev-dependencies to tests)
• [ ] the release workflow (see https://github.com/QEDjl-project/QEDbase.jl/issues/39 for a blueprint)

References

General

• https://jump.dev/JuMP.jl/dev/developers/contributing/
• https://docs.sciml.ai/Overview/stable/highlevels/developer_documentation/

Specifically for GitHub using forks

• https://github.com/ECP-WarpX/WarpX/blob/development/CONTRIBUTING.rst