Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

41 lines (24 loc) · 1.68 KB

Contributing Guidelines

💥 ⭐ Welcome Hacktoberfest! This is a great entry level project for open source participation! ⭐ 💥

Thank you for taking the interest and time to contribute to this open source project.

Getting Started

In order to get started, first you will need to clone this repo to your local machine. Next, create a feature branch, i.e. update-readme and make your changes, providing thoughtful commits.

Community

Me, myself and I! Welcome all who want to share in open source and contribute to improving this app.

Issues

Ensure the bug was not already reported by searching on GitHub under. If you're unable to find an open issue addressing the bug, open a new issue.

Write detailed information

Detailed information is very helpful to understand an issue. We have provided a template to facilitate your contribution, please ensure it is filled out as completely as possible. Complete Issues with clear information will be given priority.

For example:

  • How to reproduce the issue, step-by-step.
  • The expected behavior (or what is wrong).
  • Screenshots for GUI issues.
  • The application version.
  • The operating system.

Pull Requests

Pull Requests are always welcome. We have provided a template to facilitate your contribution, please ensure it is filled out as completely as possible. Complete PRs with clear information will be given priority.

Ensure the PR description clearly describes the problem and solution. It should include:

  • Issue # the PR fixes (if any)
  • Concise explanation of the motivation and context of the PR if no Issue
  • Any new dependencies required by the PR
  • Details of any testing done to ensure the PR functions as intended