Skip to content

Latest commit

 

History

History
16 lines (13 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

16 lines (13 loc) · 1.61 KB
Raw

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 becomming a developer. We aspire to have similar guidelines as github.

  1. Fork the repository. recommended: Delete all branches other than master. This makes it easier to see what is in your fork later.
  2. Clone the repository with the remotes origin pointing at your fork as origin and mantidproject/mantid as upstream. This is a common setup.
  3. Make changes as you see fit. Please still follow the guidelines for running the unit tests and the build servers.
  4. 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 continuious 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