Skip to content

Latest commit

 

History

History
106 lines (83 loc) · 5.05 KB

Contributing.md

File metadata and controls

106 lines (83 loc) · 5.05 KB
Raw

Contributing to pgmpy

Hi! Thanks for your interest in contributing to pgmpy. This document summarizes everything that you need to know to get started.

Code and Issues

We use Github to host all our code. We also use github as our issue tracker. Please feel free to create a new issue for any bugs, questions etc. It is very helpful if you follow the issue template while creating new issues as it gives us enough information to reproduce the problem. You can also refer to github's guide on how to efficiently use github issues.

Git and our Branching model

Git

We use Git as our version control system, so the best way to contribute is to learn how to use it and put your changes on a Git repository. There is plenty of online resources available to get started with Git:

Forks + GitHub Pull Requests

We use gitflow to manage our branches.

Summary of our git branching model:

  • Fork the desired repository on GitHub to your account.
  • Clone your forked repository locally: git clone [email protected]:your-username/repository-name.git.
  • Create a new branch off of dev branch with a descriptive name (for example: feature/portuguese-sentiment-analysis, hotfix/bug-on-downloader). You can do it by switching to dev branch: git checkout dev and then creating a new branch: git checkout -b name-of-the-new-branch.
  • Make changes to the codebase and commit it. [Imp] Make sure that tests pass for each of your commits.
  • Rebase your branch on the current dev and push to your fork on GitHub (with the name as your local branch: git push origin branch-name
  • Create a pull request using GitHub's Web interface (asking us to pull the changes from your new branch and add the changes to our dev branch).;
  • Wait for reviews and comments.

Tips

  • [Imp] Write helpful commit messages.
  • Anything in the dev branch should be deployable (no failing tests).
  • Never use git add .: it can add unwanted files;
  • Avoid using git commit -a unless you know what you're doing;
  • Check every change with git diff before adding then to the index (stage area) and with git diff --cached before committing;
  • If you have push access to the main repository, please do not commit directly to dev: your access should be used only to accept pull requests; if you want to make a new feature, you should use the same process as other developers so that your code can be reviewed.

Code Guidelines

  • We use black(https://black.readthedocs.io/en/stable/) for our code formatting.
  • Write tests for your new features (please see "Tests" topic below);
  • Always remember that commented code is dead code;
  • Name identifiers (variables, classes, functions, module names) with readable names (x is always wrong);
  • When manipulating strings, use Python's f-Strings (f'{a} = {b}' instead of '{} = {}'.format(a, b));
  • When working with files use with open(<filename>, <option>) as f instead of f = open(<filename>, <option>);
  • All #TODO comments should be turned into issues (use our GitHub issue system);
  • Run all tests before pushing (just execute nosetests) so you will know if your changes broke something;

Tests

We use Travis CI for continuous integration for linux systems and AppVeyor for Windows systems. We use python unittest module for writing tests. You should write tests for every feature you add or bug you solve in the code. Having automated tests for every line of our code let us make big changes without worries: there will always be tests to verify if the changes introduced bugs or lack of features. If we don't have tests we will be blind and every change will come with some fear of possibly breaking something.

For a better design of your code, we recommend using a technique called test-driven development, where you write your tests before writing the actual code that implements the desired feature.

Discussion

Please feel free to contact us through the mailing list if you have any questions or suggestions. Connect with us at gitter. All contributions are very welcome!

Mailing list : [email protected]

Happy hacking! ;)