When contributing to te Flux RESTful API, it is important to properly communicate the gist of the contribution. If it is a simple code or editorial fix, simply explaining this within the GitHub Pull Request (PR) will suffice. But if this is a larger fix or Enhancement, it should be first discussed with the project leader or developers. You can also join us on the Flux Framework Slack using the Contact link here to get an invitiation.
Pull Request Process¶
All pull requests should go to the main branch.
Follow the existing code style precedent. The testing includes linting that will help, but generally we use black, isort, and flake8.
Test your PR locally, and provide the steps necessary to test for the reviewers.
The project’s default copyright and header have been included in any new source files.
All (major) changes must be documented in the CHANGELOG.md in the root of the repository, and documentation updated here.
If necessary, update the README.md.
The pull request will be reviewed by others, and the final merge must be done by a project owner.
For contributing to documentation, see our Developer Guide. If you have any questions, please don’t hesitate to open an issue.