Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 3 KB

contributing.md

File metadata and controls

50 lines (32 loc) · 3 KB
Raw

Contributing Guidelines

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug 🐛
  • Discussing the current state of the code 🗣
  • Submitting a fix 🔨
  • Proposing new features 🌟
  • Becoming a maintainer 👷

Contribute using Github Pull Request Workflow

We use Github to host code, to track Issues and Feature Requests, as well as accept Pull Requests. PRs are the best way to propose changes to the codebase. We actively welcome your PRs!

If you want to contribute, just Fork this repo then use the Pull Request workflow to suggest changes e.g.

  1. Fork this repository. As in click the fork button on the top-right hand side of this web page. You will now have a fork of this repo on your own Github account.

  2. Proceed to creating your new branch (not main or master). Place an indication of what your suggested change is about e.g. hotfix (spelling mistakes etc) or feature (new suggestion/content/resources etc), and your initials in the branch name e.g. hotfix/dsp.

  3. Create the changes (you can simply edit files on Github) and commit to your new branch.

  4. Open a Pull Request pointing to the original (upstream) course repository (our maintainers will review your PR and merge should there not be any further work to do on your side).

  5. If you plan on making more contributions, make sure you sync your fork with the original repo before starting a new branch.

Report Bugs using Github Issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write Bug Reports with detail, background, and sample code.

We recommend having a quick read of stack overflow's how to ask a question guideline Also have a look at this as a good example of a bug report (Expected Behaviour vs Actual Behaviour).

Great Bug Reports tend to have:

  • A quick summary and/or background.
  • Steps to reproduce.
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen.
  • What actually happens.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work).

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft