Skip to content

Latest commit

 

History

History
141 lines (101 loc) · 5.15 KB

CONTRIBUTING.md

File metadata and controls

141 lines (101 loc) · 5.15 KB
Raw

Contributing to MMAP backed array

We welcome contributions to this library, please take a moment to read through the following guide to making contributions.

How to contribute

The preferred workflow for contributing to mmap_backed_array is to fork the main repository on GitHub, clone, and develop on a branch. Steps:

  1. Fork the project repository by clicking on the 'Fork' button near the top right of the page. This creates a copy of the code under your GitHub user account.

  2. Clone your fork of the mmap_backed_array repo from your GitHub account to your local disk:

    $ git clone [email protected]:YourLogin/mmap_backed_array.git
$ cd mmap_backed_array

  3. Create a feature branch to hold your development changes:

    $ git checkout -b my-feature

    Always use a feature branch. It's good practice to never work on the master branch!

  4. Develop the feature on your feature branch. Add changed files using git add and then git commit files:

    $ git add modified_files
$ git commit

    to record your changes in Git, then push the changes to your GitHub account with:

    $ git push -u origin my-feature

  5. Go to the GitHub web page of your fork of the mmap_backed_array repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers.

(If you are unfamiliar with Git, please look up the Git documentation on the web, or ask a friend or another contributor for help.)

Pull Request Checklist

Please follow the following rules before you submit a pull request:

  • Follow the JaggedVerge Python coding guidelines.

  • If your pull request addresses an issue, please use the pull request title to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is created.

  • All public methods should have informative docstrings.

  • Please prefix the title of your pull request with [MRG] (Ready for Merge), if the contribution is complete and ready for a detailed review. Incomplete contributions should be prefixed [WIP] (to indicate a work in progress) and changed to [MRG] when it matures. WIPs may be useful to: indicate you are working on something to avoid duplicated work, request broad review of functionality or API, or seek collaborators. WIPs often benefit from the inclusion of a task list in the PR description.

  • When adding additional functionality please provide at least one example script in the examples/ folder. Have a look at other examples for reference. Examples should demonstrate why the new functionality is useful in practice and, if possible, compare it to what is already available.

  • Because this is a core library documentation and high-coverage tests are necessary for enhancements to be accepted.

You can also check for common programming errors with the following tools:

  • Code lint, check with:
$ pip install pylint
$ pylint path/to/code

Pylint errors are indicative of critical issues, if code contains Pylint errors your pull request will be declined.

Filing bugs

We use Github issues to track all bugs and feature requests; feel free to open an issue if you have found a bug or wish to see a feature implemented.

It is recommended to check that your issue complies with the following rules before submitting:

  • Verify that your issue is not being currently addressed by other issues or pull requests.

  • Please ensure all code snippets and error messages are formatted in appropriate code blocks. See Creating and highlighting code blocks.

  • If the bug is system specific please include your operating system type and version number, as well as your Python versions. This information can be found by runnning the following code snippet:

import platform; print(platform.platform())
import sys; print("Python", sys.version)

New contributor tips

Tackling an issue is a great way to contribute and improve the library. Creating example code is also another way in which you can make a contribution to the library.

Documentation

We are glad to accept any sort of documentation: function docstrings, reStructuredText/markdown documents (like this one), tutorials, etc. reStructuredText/markdown documents should go in the source code repository under the doc/ directory.

Further Information

Visit the JaggedVerge to get more information about the community behind this project.