Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 4.92 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 4.92 KB

Contributing

A big welcome and thank you for considering contributing to this open source project! It’s people like you that make it a reality for users in our community.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalise your pull requests.

Quicklinks

Code of Conduct

We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • To report security vulnerabilities please speak with Michael Whittle.
  • Search for existing Issues and PRs before creating your own.
  • We work hard to make sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

Issues

Issues should be used to report problems with the application, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.

Discussions

Please use the Discussion for Q&A

Coding Rules

It is essential that the project code guidelines are followed. A PR that is not compliant will not be merged.

  1. Please use black to format your code before opening a pull request (Alt+Shift+F in VSCode)
  2. Please make sure you comment your code, without spelling mistakes
  3. Please use descriptive variable names
  4. Please use snake case for function and variable names E.g. my_variable not myVariable
  5. Please create classes with a singular purpose
  6. Please avoid really large functions, break them up into smaller units.
  7. Please avoid code duplication, use functions and sub-functions
  8. Do not disable flake8/PEP8 warnings and errors without approval
  9. Run and make sure "pre-release-check.sh" is clear before raising a PR to beta
  10. Your PR needs to contain unit tests to be merged

Pull Requests

PRs to this application are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

  • Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
  • Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
  • Address a single concern in the least number of changed lines as possible.
  • Include comments in the code.
  • Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the "fork-and-pull" Git workflow

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
    • feature_name or feature/name for feature branches
    • hotfix_name or hotfix/name for hotfix branches
  4. Commit changes to the branch
  5. Following any formatting and testing guidelines specific to this repo
  6. Increment the version number in the README. Try and follow SemVer. If you're unsure, reach out to the contributors.
  7. Push changes to your fork
  8. Open a PR in this repository against the beta branch and follow the PR template so that we can efficiently review the changes.

Getting Help

Join us in the Telegram PyCryptoBot Chat and/or Telegram PyCryptoBot Dev Chat.