Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

How to contribute

The gdphelper follows GitHub worflow. The steps we are going to follow to contribute to this project are:

  • Create a branch.

  • Commit changes.

  • Create a pull request.

  • One contributor should check the changes and approve them.

  • Finally, merge the pull request.

If you are a new contributor to the project, visit : https://github.com/UBC-MDS/gdphelper and click the ‘Fork’ icon to get a copy of the project.

Clone the repository locally:

Add the upstream repository:

Create a branch with a suitable name. E.g branch name ‘test’:

Commit locally your progress with an proper commit message.

Create a pull request in the Github website using the green button.

Finally the pull must be aproved by at least one of the core team members before merging to the main branch.

Code of Conduct

Please note that the gdphelper project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.