Contributing Guide

A Contributing Guide for Open-Source project contributors

<h1 align=center>Contributing</h1>

Thank you for considering and taking the time to contribute!
The following are the guidelines for contributing to this project:

## How to Report Bugs
Please open a new issue with steps to reproduce the problem you're experiencing.
Provide as much information as possible, including screenshots, text output, and both your expected and actual results.

## How to Request Enhancements
First, please refer to the [issues](https://github.com/username/repo/issues) section of this project and search [the repository's GitHub issues](https://github.com/username/repo/issues) to make sure that your idea has not been (or is not still) considered.
Then, please [create a new issue in the GitHub repository](https://github.com/username/repo/issues) describing the enhancement you would like to have.
Be sure to include as much detail as possible including step-by-step descriptions, specific examples, screenshots or mockups, and providing a reason why the enhancement might be worthwhile.

## Here are some quick guide of some common ways to contribute :
### Issues
[**Issues**](https://github.com/username/repo/issues/new/choose) are very valuable to this project. Please check if any similar issues are already present. If not, then feel free to open that issue.
  - **Feature 💡 Requests** are valuable sources of enhancements which the project can make.
  - **Bug 🐞 Reports** show where this project is lacking and errors come up.
  - With a **question**, you show where contributors can improve the user experience.

### Projects
[**Projects**](https://github.com/users/username/projects/project_number) lists the **tasks _completed_, _in progress_ and _the ideas left to be incorporated_ in the project**. Contributors can work on the **To-Do tasks** by _**creating the issue** (if not present) and **getting themselves assigned**_.

### Pull Requests
[**Pull requests**](https://github.com/username/repo/pulls) are a great way to get your ideas (through code changes) into this project. Please open an issue at first, describing the changes you want to make, then feel free to open a PR (Pull Request).

#### Does it state intent ?
You should be _clear_ which problem you're trying to _solve or the feature you want to include_ with your contribution.

For example:

> Added some files

Doesn't tell me anything about why you're doing that

> Add files to make the app more user friendly

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.

PreviousPush to Pull Requests Action NextSecurity

Last updated 3 days ago

Was this helpful?

<h1 align=center>Contributing</h1> Thank you for considering and taking the time to contribute! The following are the guidelines for contributing to this project: ## How to Report Bugs Please open a new issue with steps to reproduce the problem you're experiencing. Provide as much information as possible, including screenshots, text output, and both your expected and actual results. ## How to Request Enhancements First, please refer to the [issues](https://github.com/username/repo/issues) section of this project and search [the repository's GitHub issues](https://github.com/username/repo/issues) to make sure that your idea has not been (or is not still) considered. Then, please [create a new issue in the GitHub repository](https://github.com/username/repo/issues) describing the enhancement you would like to have. Be sure to include as much detail as possible including step-by-step descriptions, specific examples, screenshots or mockups, and providing a reason why the enhancement might be worthwhile. ## Here are some quick guide of some common ways to contribute : ### Issues [**Issues**](https://github.com/username/repo/issues/new/choose) are very valuable to this project. Please check if any similar issues are already present. If not, then feel free to open that issue. - **Feature 💡 Requests** are valuable sources of enhancements which the project can make. - **Bug 🐞 Reports** show where this project is lacking and errors come up. - With a **question**, you show where contributors can improve the user experience. ### Projects [**Projects**](https://github.com/users/username/projects/project_number) lists the **tasks _completed_, _in progress_ and _the ideas left to be incorporated_ in the project**. Contributors can work on the **To-Do tasks** by _**creating the issue** (if not present) and **getting themselves assigned**_. ### Pull Requests [**Pull requests**](https://github.com/username/repo/pulls) are a great way to get your ideas (through code changes) into this project. Please open an issue at first, describing the changes you want to make, then feel free to open a PR (Pull Request). #### Does it state intent ? You should be _clear_ which problem you're trying to _solve or the feature you want to include_ with your contribution. For example: > Added some files Doesn't tell me anything about why you're doing that > Add files to make the app more user friendly Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.