-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0159ae6
commit 93d0cc0
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Contributing | ||
|
||
Thank you for considering contributing to this project! This document will outline how to submit changes to this repository and which conventions to follow. | ||
|
||
## Prerequisites | ||
|
||
- **You're familiar with GitHub Issues and Pull Requests** | ||
|
||
## Issues before PRs | ||
|
||
1. Before you start working on a change please make sure that there is an issue for what you will be working on. You can either find and [existing issue](https://github.com/siddhantdixit/LinkStack/issues) or [open a new issue](https://github.com/siddhantdixit/LinkStack/issues/new) if none exists. Doing this makes sure that others can contribute with thoughts or suggest alternatives, ultimately making sure that we only add changes that make | ||
|
||
2. When you are ready to start working on a change you should first [fork this repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [create a new branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository). | ||
3. Make your changes. | ||
4. [Open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Your PR will soon be reviewed and approved. | ||
|
||
### Commits | ||
|
||
Strive towards keeping your commits small and isolated - this helps the reviewer understand what is going on and makes it easier to process your requests. | ||
|
||
### Pull Requests | ||
|
||
In your PR's description you should follow the structure: | ||
|
||
- **What** - what changes are in this PR | ||
- **Why** - why are these changes relevant | ||
- **How** - how have the changes been implemented | ||
- **Testing** - how has the changes been tested or how can the reviewer test the feature | ||
|
||
Please add screenshots wherever necessary. | ||
|
||
It is highly encouraged that you do a self-review prior to requesting a review. To do a self review click the review button in the top right corner, go through your code and annotate your changes. This makes it easier for the reviewer to process your PR. |