Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
278 lines (186 loc) · 7.34 KB

CONTRIBUTING.md

File metadata and controls

278 lines (186 loc) · 7.34 KB
Raw

Contributing Guide

Welcome

Welcome and thank you for considering contributing to this project! Please take a moment to read the basics about working on this project and be aware of our Code-of-Conduct.

We welcome any type of contribution:

  • Code: add code through pull requests including new features or bug fixes (check the open issues)
  • QA: add issue, label it as bug or comments to other issues
  • Roadmap: contact us if you have ideas to be considered in our roadmap
  • Exploitation: write blog posts, tutorials, present the project on public events, ...

If you just want to know how to use the project, see README.md

Is this your first contribution on Github?

If you are not sure how to work with Pull Requests, you can find an introduction here: How to Contribute to an Open Source Project on GitHub.

Pull Request Guidelines

  • If you want to add a new feature, add a issue (with label enhancement) first so that the community has the chance to discuss it and provide helpful input
  • Consider the branch naming converntions
  • Keep your commit history clean: changes are atomic and the git message format is considered
  • Always rebase your work on top of the upstream branch to ensure your commit history is clean and linear
  • Keep the .gitignore file up-to-date
  • Keep the setup.cfg, setup.py and requirements.txt files up-to-date
  • Feature added?
    • Make sure that the feaure is tested and add a new test if needed
  • pytest need to be passed
  • Coding Guidelines have to be considered: We use flake8 and base on pep8

Branch Naming Convention

Base your work on the master branch (as the current snapshot) or a current release branch if available.

  • feature-* for new features
  • fix-* for bug fixes
  • tests-* when updating test suite
  • refactor-* when refactoring code without bbehavior changes
  • docs-* for README.md updates (or similar documents)

Commit Messages

Make sure that you have your own user and email setup correctly in git before you commit

Take the time to write good commit messages.

Commit message template:

---- start ----
[short line describing main purpose]
-- empty line --
[description, why this change is made]
-- empty line --
[close/fix #xxxx - representing dedicated github issue ids]
---- end ----

Comments

Please add comments to your code changes.

Uss PEP 257 Docstring Conventions in your comments.

Check the api documentation by using pydoc

$ python -m pydoc msb_client

You can also start a webserver with documentation

$ python -m pydoc -p 9010

Review of the Pull Request

After you have created your Pull Request, a project maintainer reviews it and decides wether it will be merged or rejected.

Try to avoid large Pull Requests as it will take longer to review them.

Development Setup

Requirements:

  • Setup Python version 3.9.x
  • Pipenv for package management and virtual environments (see below)

Editor Suggestion:

Setup pipenv to develop in a virtual environment

$ pip install pipenv
$ python -m pipenv install --dev

And always run your development inside the pipenv shell

$ python -m pipenv shell

This will ensure that you use a virtual environment that is separated from the global python packages.

Install the msb_client python package in the virtual environment:

$ python setup.py install

Development Lifecycle

Step 1: Fork

Fork the project on GitHub and clone this fork locally.

$ git clone git@github.com:username/<forkedprojectname>.git
$ cd <forkedprojectname>
$ git remote add upstream https://github.com/<projectname>/<projectname>.git
$ git fetch upstream

Step 2: Branch

Create local branches to hold your changes.

These should be branched directly off of the master or release-* branch.

$ git checkout -b my-branch -t upstream/master

Note that your new branch will track changes of the upstream/master now.

Step 3: Install/Build

To get all required dependencies, run:

$ pipenv install

Now you are ready to make changes.

Step 4: Code

If you have made some code changes, be aware of the coding guidelines.

We use flake8 and base on pep8.

After you have changed code, check for new pep8 or other issues

$ flake8

Some rules can be auto-fixed by eslint

$ autopep8 ./ --recursive --in-place --verbose

It is also recommended to install pylint for Visual Studio Code.

Step 5: Commit

Keep your changes grouped logically within individual commits. This will make the review process easier.

$ git add changed/files
$ git commit -m "Commit message"

Step 6: Rebase

Use git rebase after you have commited a change.

Do NOT use git merge.

$ git fetch upstream
$ git rebase upstream/master

If there are conflicts, solve them e.g. by using a diff tool like Meld.

Then continue to rebase

$ git rebase --continue

This ensures that your working branch has the latest changes from the upstream repository and your history is clean and linear.

In case you want to abort the rabse process:

$ git rebase --abort

Step 7: Test

New features should also add new tests.

Unit test are written as pytest.

Run the basic tests before submitting a Pull Request

$ pytest -s test/test_unit.py

All unit tests have to be passed!

Run also integration tests against local or remote MSB instance:

$ TESTENV_CUSTOMIP=192.168.0.10 pytest -s test/test_integration.py

TODO: Link to runing MSB test instances

More information about testing and coverage reports: Testing

Step 8: Push

Once you have finished your work prepare your pull request by pushing your working branch to your fork on GitHub.

$ git push origin my-branch

Step 9: Opening the Pull Request

Create a new pull request from your fork on Github. A pull request template will help you to provide all information needed and to check if all requirements are met.

Step 10: Update a Pull Reuest

It is likely that you get some comments to your Pull Request and requests for changes by the reviewer. This is part of the review process.

In this case, you can still make changes to the existing Pull Request.

Simply make the changes to your local branch, add a new commit and push to your fork. GitHub will automatically update the pull request.

$ git add changed/files
$ git commit -m "Commit message"
$ git push origin my-branch

Check if a git rebase is neccessary before. If you have a conflict after a rebase with your remote branch on origin, and you are the ONLY one working on it, you can overwrite it on origin by

$ git push --force origin my-branch

Step 11: Finally

The Pull Requests will be successfully merged if:

  • Code reviewer accepted the Pull Request
  • CI successfully checked the branch of the Pull Request

License

By contributing to this project, you agree that your contributions will be licensed under its LICENSE.

Questions

If you have any questions, add an issue and label it as question