-
Notifications
You must be signed in to change notification settings - Fork 0
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 smartcontractkit#1841 from RohitKS7/patch-1
CONTRIBUTING.md added
- Loading branch information
Showing
1 changed file
with
35 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,35 @@ | ||
# How do I make a contribution? | ||
|
||
Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown! | ||
|
||
- Find an issue that you are interested in addressing or a feature that you would like to add. | ||
|
||
- Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under `your-GitHub-username/repository-name`. | ||
|
||
- Clone the repository to your local machine using `git clone https://github.com/github-username/repository-name.git`. | ||
|
||
- Create a new branch for your fix using `git checkout -b branch-name-here`. | ||
|
||
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add. | ||
|
||
- Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index. | ||
|
||
- Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message. | ||
|
||
- Push the changes to the remote repository using `git push origin branch-name-here`. | ||
|
||
- Submit a pull request to the upstream repository. | ||
|
||
- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so **"Added more log outputting to resolve #4352"**. | ||
|
||
- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! | ||
|
||
- Wait for the pull request to be reviewed by a maintainer. | ||
|
||
- Make changes to the pull request if the reviewing maintainer recommends them. | ||
|
||
- Celebrate your success after your pull request is merged! | ||
|
||
# Where can I go for help? | ||
|
||
If you need help, you can ask questions on our **discussions** tab. |