Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

54 lines (42 loc) · 2.56 KB
Raw

Contributing to OrganiseDesktop

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

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation including README.md.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

How to Clone the Repository (using JetBrains IDE - Pycharm)

  1. Fork the repo and create a branch from master
  2. Copy the Github URL made from the fork
  3. Open PyCharm and go to VCS on the top menu bar
  4. Click on VCS -> Get From Version Control and insert the url into the space
  5. Clone the Repo!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's 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

This is an example.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • What OS you were running on
  • What Python version you were running
  • 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)

Please join the slack channel

If you have any questions or need help with your input, join the slack channel for help! We all work together! https://join.slack.com/t/organisedesktop/shared_invite/enQtMzA2NTI2MTI0MzY4LWRlOWRjOGM0YTJmYjFiZGU3ZTUzM2M0MTA2N2U3MzljMmFhNGIyODlmZDg2N2E1Y2EwOWFiZjcxMzYzYjcyMTk