Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.56 KB
Raw

How to contribute

Want to participate/contribute to ProcessTracking? Feel free to add any enhancements, feature requests, etc.

Getting Started

  • Check out the project's development branch and create a new Python 3.7+ virtualenv.

  • Install pipenv::

          $ pip install pipenv

  • Install all necessary requirements::

          $ pipenv install

  • Make sure you have a GitHub account <https://github.com/signup/free>_

  • Submit issues/suggestions to the Github issue tracker <https://github.com/OpenDataAlex/process_tracker/issues>_

    • For bugs, clearly describe the issue including steps to reproduce. Please include stack traces, logs, screen shots, etc. to help us identify and address the issue.
    • Please ensure that your contribution is added to the correct project (i.e. docs, workflow, etc. in process_tracker , python bug or implementation changes goes to process_tracker_python, etc.)
    • For text based artifacts, please use: Gist <https://gist.github.com/>_ or Pastebin <http://pastebin.com/>_
    • For enhancement requests, be sure to indicate if you are willing to work on implementing the enhancement
    • Fork the repository on GitHub if you want to contribute code/docs

Making Changes

  • Make commits of logical units with complete documentation.

    • Code should be formatted with black.

    • Check for unnecessary whitespace with git diff --check before committing.

    • Make sure you have added the necessary tests for your changes.

    • Test coverage is currently tracked via coveralls.io <https://coveralls.io/github/OpenDataAlex/>_

    • Aim for 100% coverage on your code

    • If this is not possible, explain why in your commit message. This may be an indication that your code should be refactored.

  • To make sure your tests pass, run::

          $ python setup.py test

  • If you have the coverage package installed to generate coverage data, run::

          $ coverage run --source=process_tracker_python setup.py test

  • Check your coverage by running::

          $ coverage report

Submitting Changes

  • Push your changes to the feature branch in your fork of the repository.
  • Submit a pull request to the main repository
  • You will be notified if the pull was successful. If there are any concerns or issues, a member of the ProcessTracker maintainer group will reach out.

Additional Resources

  • General GitHub documentation <http://help.github.com/>_
  • GitHub pull request documentation <https://help.github.com/en/articles/about-pull-requests>_