Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 4.75 KB

CONTRIBUTING.md

File metadata and controls

88 lines (60 loc) · 4.75 KB

Contributing to Donatify Home

👏First off, thanks for taking the time to contribute!👏

We are looking forward to contributions that will enable lesser human intervention!

Please do take a look at our Code of Conduct.

Code of Conduct

This project and everyone participating in it is governed by the repository owner. By participating, you are expected to uphold this code. Please report unacceptable behavior to the repository owner.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report.

Before submitting an issue please:

  • Check the troubleshooting section in the README file.
  • Determine the repository in which the issue should be reported in.
  • Perform a cursory search to check if the problem was already reported or not. If this is an open issue, please do add a comment to it.

How Do I Submit A (Good) Bug Report?

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for the Donatify.

Before Submitting An Enhancement Suggestion

  • Check the troubleshooting section in the README file.
  • Determine the repository in which the enhancement should be suggested in.
  • Perform a cursory search to check if the enhancement was already suggested or not. If this is an open issue, please do add a comment to it.

How Do I Submit A (Good) Enhancement Suggestion?

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see or add instead and why.

Pull Requests

The process described here has several goals:

  • Maintain Repo's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible working.
  • Enable a sustainable system for repo's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the styleguides
  2. After you submit your pull request, verify that all status checks are passing.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:

Python Style Guide

Please do follow this guide to maintain the standard Python formatting PEP-8

JavaScript Style Guide

Please do follow this guide to maintain the standard JavaScript formatting eslint

Technical Guide

  • Make sure you are working in the correct project directory.
  • Make sure you are working on the correct versions of python, npm, node, and pip.
  • Make sure you are working on a separate development enviroment and install all the requirements to this enviroment.

Attribution

These Contributing guidelines are adapted from the Atom's contributing guidelines.