-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from jaygala223/patch-2
add examples in CONTRIBUTING.md
- Loading branch information
Showing
2 changed files
with
50 additions
and
5 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
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 |
---|---|---|
@@ -1,11 +1,55 @@ | ||
Given below is the general workflow we expect you to follow while making contributions to this project. | ||
|
||
|
||
### Workflow | ||
1. Go to the issues tab and find an issue you would like to work on. | ||
|
||
1.1. Clarify any doubts in the comments section of the issue. | ||
|
||
2. Fork the project | ||
|
||
3. Create a branch and make small changes on it. | ||
|
||
4. Create a **draft PR** | ||
|
||
5. Then make other changes and push to the remote branch you created. In this way, the maintainers will be able to provide early reviews and comments for your commits which will save time later on. | ||
|
||
|
||
6. Once the above steps are done, you can change the PR status from **draft to active** | ||
|
||
|
||
7. Once the PR is approved, make sure to update and sync your branch | ||
|
||
8. Wait for the maintainers to merge your contribution | ||
|
||
9. Congratulations! You made your first contribution to Leet Easy | ||
|
||
<br> | ||
|
||
### Fixing a bug, or adding a new feature | ||
|
||
This section generally defines how you can make code contribution. Please follow the below instructions to make code contributions. | ||
|
||
Code, PR, commit message format, etc convension I follow when I code. Please follow the links below to get details. | ||
Please follow the links given below to see the code, PR, commit message, etc. conventions which we follow. | ||
|
||
- [Git branch naming convension](BRANCH-NAMING.md) | ||
- [Git branch naming convention](BRANCH-NAMING.md) | ||
|
||
- [Conventional Commits](https://www.conventionalcommits.org/) for commit messages, and [Commit message format](https://gist.github.com/digitaljhelms/3761873) for what to write | ||
|
||
- [Linking a PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) | ||
|
||
<br> | ||
|
||
### Examples | ||
|
||
#### Branch Names: `{branch_type}/{issue-tracker-id-}issue-one-liner` | ||
1. feature/2234-infinite-scroll | ||
2. documentation/3344-linux-installation | ||
3. test/2222-unit-tests | ||
|
||
#### Commits | ||
1. [#1234] feature: Submit button added. | ||
2. [#1232] fix: Infinite scroll fixed | ||
3. Add unit tests for xyz feature | ||
|
||
Keep contributing. We're eager to see your contributions! |