Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 2.09 KB
Raw

Contributing to HighDimMixedModels.jl

To make contributions to HighDimMixedModels.jl, you need to set up your GitHub account if you do not have and sign in, and request your change(s) or contribution(s) via a pull request against the main branch of the HighDimMixedModels.jl repository.

Please use the following steps:

  1. Open a new issue for new feature or failed function in the issue tracker
  2. Fork the HighDimMixedModels.jl repository to your GitHub account
  3. Clone your fork locally:
$ git clone https://github.com/your-username/HighDimMixedModels.jl.git
  1. Make your change(s) in the main branch of your cloned fork
  2. Make sure that all tests (test/runtests.jl) are passed without any errors
  3. Push your change(s) to your fork in your GitHub account
  4. Submit a pull request describing what problem has been solved and linking to the issue you had opened in step 1

Your contribution will be checked and merged into the original repository. You will be contacted if there is any problem in your contribution

Please try to include the following information in your pull request:

  • Code which you are contributing to this package

  • Documentation of this code if it provides new functionality. This should be a description of new functionality added to the docs. Check out the docs folder for instructions on how to update the documentation.

  • Tests of this code to make sure that the previously failed function or the new functionality now works properly

These Contributing Guidelines have been adapted from the Contributing Guidelines of AtomNeb-py! (License: MIT)