Skip to content

Latest commit

 

History

History
160 lines (105 loc) · 5.85 KB

CONTRIBUTING.md

File metadata and controls

160 lines (105 loc) · 5.85 KB
Raw

Contribution, getting started

Contributions are highly welcomed and appreciated. Every little help counts, so do not hesitate!

Create your own development environment

We use conda as our main packaging system, though pip work as well. Nevertheless, the following instructions describe how to make your development environment using conda.

Create a new environment

$ conda create -n monitor-server-api-dev python=3 -c https://conda.anaconda.org/conda-forge -c defaults

Install the dependencies

$ conda install --file requirements-dev.txt -n monitor-server-api-dev -c https://conda.anaconda.org/conda-forge -c defaults

Activate your environment

$ conda activate monitor-server-api-dev

Install monitor-server-api in development mode

$ python setup.py develop

You're done!

Feature request and feedbacks

We'd like to hear about your propositions and suggestions. Feel free to submit them as issues and:

  • Explain in detail how they should work.
  • Keep the scope as narrow as possible. This will make it easier to implement.

Report bugs

Report bugs for monitor-server-api in the issue tracker. Every filed bugs should include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting, specifically:
    • the Python interpreter version
    • installed libraries and their versions
  • Detailed steps to reproduce the bug.

Fix bugs

Look through the GitHub issues for bugs.

Implement features

Look through the GitHub issues for enhancements.

Preparing Pull Requests

Short version

  1. Fork the repository.
  2. Target master for bugfixes, features or doc changes.
  3. Follow PEP-8 for naming.
  4. Tests are run using pytest: $ pytest.The test environments above are usually enough to cover most cases locally.
  5. Write a changelog entry: changelog/2574.bugfix.rst, use issue id number and one of bugfix, removal, feature, vendor, doc or trivial for the issue type.
  6. Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section).Please add yourself to the AUTHORS file, in alphabetical order.

Long version

What is a "pull request"? It informs the project's core developers about the changes you want to review and merge. Pull requests are stored on GitHub servers. Once you send a pull request, we can discuss its potential modifications and even add more commits to it later on. There's an excellent tutorial on how Pull Requests work in the GitHub Help Center.

Here is a simple overview, with monitor-server-api specific bits:

Fork

Fork the monitor-server-api GitHub repository. It's fine to use monitor-server-api as your fork repository name because it will live under your user.

Clone your fork locally using git clone <https://git-scm.com/> and create a branch:
$ git clone git@github.com:YOUR_GITHUB_USERNAME/monitor-server-api.git
$ cd monitor-server-api

# now, to fix a bug create your own branch off "master":
$ git checkout -b fix/your-bugfix-branch-name master

# or to instead add a feature create your own branch off "master":
$ git checkout -b feature/your-feature-branch-name master

Given we use semantic versioning, we have "major.minor.micro" version numbers, bugfixes will usually be released in micro releases whereas features will be released in minor releases and incompatible changes in major releases.

If you need some help with Git, follow this quick start guide

Install pytest

pytest is used to run all the tests

$ pip install pytest
Run all the tests

You need to have at least Python 3.6 available in your system. Now running tests is as simple as issuing these commands:

$ conda activate monitor-server-api-dev
$ pytest
You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 for naming.

You can pass different options to pytest. For example, to run tests and pass options (e.g. enter pdb on failure) to pytest you can do:

$ pytest -- --pdb

Or to only run tests in a particular test module:

$ pytest -- tests/test_config.py
Commit and push once your tests pass and you are happy with your change(s):
$ git commit -a -m "<commit message>"
$ git push -u
Create a new changelog entry in changelog.

The file should be named <issueid>.<type>.rst, where issueid is the number of the issue related to the change and type is one of bugfix, removal, feature, vendor, doc or trivial. You may not create a changelog entry if the change doesn't affect the documented behaviour of monitor-server-api.

Add yourself to AUTHORS file if not there yet, in alphabetical order.
Finally, submit a pull request through the GitHub website using this data:
head-fork: YOUR_GITHUB_USERNAME/monitor-server-api
compare: your-branch-name

base-fork: js-dieuTech/monitor-server-api
base: master          # if it's a bugfix
base: features        # if it's a feature