Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 2.56 KB

Contributing to pyEQUIB

The following guidelines are designed for contributors to the pyEQUIB Python package, which is hosted in the pyEQUIB repository on GitHub.

Reporting Issues

The issue tracker is used to report bugs, request new functionality, and discuss improvements. For reporting a bug or a failed function or requesting a new feature, you can simply open an issue in the issue tracker of the pyEQUIB repository. If you are reporting a bug, please also include a minimal code example that reproduces the problem, and Python version you are using.

Contributing Code

Fo contributing code to pyEQUIB, you need to set up your GitHub account if you do not have and sign in, and request your change(s) or contribution via opening a pull request against the master branch in your fork of the pyEQUIB repository.

To contribute to this package, you need to follow these steps:

  • Open a new issue for new feature or failed function in the Issue tracker.

  • Fork the pyEQUIB repository to your GitHub account.

  • Clone your fork of the pyEQUIB repository:

    $ git clone [email protected]:your-username/pyEQUIB.git

  • Make your change(s) in the master branch of your cloned fork.

  • Make sure that it passes all tests and there is no error.

  • Push yout change(s) to your fork in your GitHub account.

  • Submit a pull request, mentioning what issue has been addressed.

Then, you are waiting, until your contribution is checked and merged into the original repository. We will contact you if there is a problem in your code.

While you are opening a pull request for your contribution, be sure that you have included:

  • 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 API documentation (in docs/).

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

  • Revision history if you fixed a bug in the previously failed function or add a code for new functionality, you should well document your change(s) or addition in the Revision History entry of the changed or added function in your code.