diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e179267..f42e65c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,59 @@ ## Build -Sloop uses GitHub to manager reviews of pull requests +Sloop uses GitHub to manage reviews of pull requests + +[Singing up for a GitHub account](https://docs.github.com/en/github/getting-started-with-github/signing-up-for-a-new-github-account) if you don't have one + + ## Steps to Contribute -ADD +1.[Pick an issue you are interested in working on](https://github.com/salesforce/sloop/issues). +It’s a good idea to comment on an Issue that you want to help with and ask some questions before doing any major coding work + +2.Fork the repository: Look for the “Fork” button in the top right corner of [salesforce/sloop repo](https://github.com/salesforce/sloop) + +3.Clone the fork: Click on the green “clone or download” button,you can choose “clone with HTTPS.” Or, you can use SSH, which is compatible with 2-factor authentication, but just [some more work to set up](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh). +Go to the folder where you want to save the repository, type `git clone that-https-url-you-copied` + +4: Add a remote pointing to the original repository so you can sync changes: `git remote add upstream git@github.com:salesforce/sloop.git` + +5.Make a git branch: If you type git status you will see the branch name that you’re on, called master. In most projects, master is a special place where the most stable, reviewed, up-to-date code is. So, you’ll need to make your own branch and switch to that branch: +`git checkout -b name-for-your-branch` + +6.Make some commits: + +When you have some code that you want to keep, you should save it in git by creating a commit. Here’s how: + +`git status` shows you the files you changed + +`git add path-to-your-file` allows you to pre-select the files you want to save + +`git status` again to make sure you added the files you want to keep + +`git commit -m "some message here #123"` groups your changes together into a commit. The message should be short, describe the work that you did, and include the issue number that you are working on. + +`git push origin name-for-your-branch` to save your work online + +7.Open a Pull Request: To create one, go to your fork of the project, click on the Pull Requests tab, and click the big green “New Pull Request” button. After you choose your branch, +click the green “Create Pull Request” button. It will be super helpful if you can write a sentence or two summarizing the work you did and include a link to the Issue you were working on. +If you are working on a new issue, please create one under Issues tab + +8.Expect changes and be patient: Next up, a maintainer or contributor will review your code. Once your work is approved, it will be merged in! +Congratulations and thank you for giving back to the open source community :) + + ## Pull Request Checklist +1.Design -ADD +2.Functionality + +3.Tests + +4.Naming + +5.Comments ## Dependency Management