The developer documentation has information on how to participate in the mantid project as a developer. This document is meant to outline the steps for contributing to mantid without becoming a developer. We aspire to have similar guidelines as github.
- Fork the repository. recommended: Delete all branches other than
main. This makes it easier to see what is in your fork later. - Clone the repository with the remotes
originpointing at your fork asoriginandmantidproject/mantidasupstream. This is a common setup. - Make changes as you see fit. Please still follow the guidelines for running the unit tests and the build servers.
- Submit a pull request to this branch. This is a start to the conversation.
If you need help, you can go to the forum.
Hints to make the integration of your changes easy (and happen faster):
- Keep your pull requests small
- Watch for the results of continuous integration
- Don't forget your unit tests
- All algorithms need documentation, don't forget the .rst file
- Much of the work in mantid gets publicised the release notes, please add a summary of your work there
- Don't take changes requests to change your code personally