|
1 | 1 | # Contributing Guidelines |
2 | 2 |
|
3 | | -- [Contributing Guidelines](#contributing-guidelines) |
4 | 3 | - [Getting Started](#getting-started) |
5 | | -- [Submission Template](#submission-template) |
6 | | -- [Submitting Your Contribution](#submitting-your-contribution) |
| 4 | + - [Project Setup](#project-setup) |
| 5 | + - [Adding to the project]() |
| 6 | +- [Make & Commit your Changes](#make--commit-your-changes) |
| 7 | + - [Submission Template](#submission-template) |
| 8 | +- [Create a Pull Request (PR)](#create-a-pull-request-pr) |
| 9 | + |
7 | 10 |
|
8 | 11 | ## Getting Started |
9 | 12 |
|
10 | | -1. Fork the project on GitHub to your own repository. |
11 | | -2. Clone your forked repository to your local machine: `git clone <https://github.com/your-username/your-repo.git>` |
12 | | -3. Create a new branch for your contribution: `git checkout -b branchName/your-idea` |
| 13 | +Contributing to open source projects, like this one, can be a rewarding experience allowing participants to learn, teach, share and gain experience. |
| 14 | + |
| 15 | +View openBookmarkz/ideas open [issues here](https://github.com/openBookmarkz/ideas/issues) and follow the instructions below to contribute to this project. |
| 16 | + |
| 17 | + |
| 18 | +### Project Setup |
| 19 | + |
| 20 | +1. Create a [Fork of this project](https://github.com/openBookmarkz/ideas/fork). This will create a copy of the original repository in your GitHub account that you own, allowing you to make changes without affecting the original repo. |
| 21 | + |
| 22 | + [](https://gyazo.com/627b749f3579b667764b2aa5bdb1d62e) |
| 23 | + |
| 24 | +2. Go to the forked repo in your GitHub (if the page hasn't automatically opened, you can find this in your repositories) and click the `Code` button. Choose HTTPS (or SSH if you have this setup) and copy the link. |
| 25 | + |
| 26 | + [](https://gyazo.com/31267ab345a0953d8029e27ab99822a8) |
| 27 | + |
| 28 | +3. In your IDE, open a terminal/command line, and run the following command to clone your forked repo into the IDE: |
| 29 | + |
| 30 | + ```bash |
| 31 | + git clone <insert copied link from step 2 here> |
| 32 | + ``` |
| 33 | + |
| 34 | +4. Set the upstream (the original repo) by running the following command in the terminal/command line: |
| 35 | + |
| 36 | + ```bash |
| 37 | + git remote add upstream https://github.com/openBookmarkz/ideas.git |
| 38 | + ``` |
| 39 | + |
| 40 | +5. Confirm that the upstream has been correctly added by running `git remote -v` in the terminal/command line. This will then output two origin links and two upstream links. The origin links are used for pushing and fetching from your forked repo. The upstream are used to push and fetch from the original repo. You should see something similar to the example below: |
| 41 | + |
| 42 | + ```bash |
| 43 | + git remote -v |
| 44 | +
|
| 45 | + origin [email protected]:kera-cudmore/ideas.git (fetch) |
| 46 | + origin [email protected]:kera-cudmore/ideas.git (push) |
| 47 | + upstream https://github.com/openBookmarkz/ideas.git (fetch) |
| 48 | + upstream https://github.com/openBookmarkz/ideas.git (push) |
| 49 | +
|
| 50 | + ``` |
| 51 | + |
| 52 | + |
| 53 | +4. Create a new branch to work on. In the terminal/command line run the following command: |
| 54 | + |
| 55 | + ```bash |
| 56 | + git checkout -b <branchName/your-idea> |
| 57 | + ``` |
| 58 | + |
| 59 | +5. Tell Git to track this branch. In the terminal/command line run the following command: |
| 60 | + |
| 61 | + ```bash |
| 62 | + git push -u origin <branch name> |
| 63 | + ``` |
| 64 | + |
| 65 | +## Make & Commit your Changes |
| 66 | + |
| 67 | +Once you are happy with your changes, you will want to commit the changes to your forked repo and then submit a pull request using the submission template back to the original repo. A Pull Request (PR) is how a contributor begins the process of merging their changes back into the original project. |
| 68 | + |
| 69 | +1. Add, commit and push your changes to your forked repository: |
| 70 | + |
| 71 | + ```bash |
| 72 | + git add <filename> |
| 73 | + git commit -m "<Commit message here>" |
| 74 | + git push |
| 75 | + ``` |
| 76 | + |
| 77 | + |
| 78 | +### Submission Template |
| 79 | + |
| 80 | +Kindly utilize the [Submission Template](https://github.com/openBookmarkz/ideas/tree/main/ideaTemplate) as a reference for the submission of your idea. |
| 81 | + |
| 82 | + |
| 83 | +## Create a Pull Request (PR) |
| 84 | + |
| 85 | +1. In the [original repo](https://github.com/openBookmarkz/ideas) click the Pull Requests tab in the top menu. |
| 86 | + |
| 87 | +  |
| 88 | + |
| 89 | + |
| 90 | +2. You should be able to see a yellow banner at the top of the screen with a green button that says `compare & pull request`. Clicking this button will start the Pull Request process. |
| 91 | + |
| 92 | +  |
13 | 93 |
|
14 | | -## Submission Template |
| 94 | +3. This will open the pull request page where you can provide a comprehensive overview of your contribution using the pre-populated [Idea Template](https://github.com/openBookmarkz/ideas/tree/main/ideaTemplate). Please fill out the template with your contribution and [reference the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) (if applicable). |
15 | 95 |
|
16 | | -Kindly utilize this [template](https://github.com/openBookmarkz/ideas/tree/main/ideaTemplate) as a reference for the submission of your idea. |
| 96 | + |
| 97 | +  |
17 | 98 |
|
18 | | -## Submitting Your Contribution |
| 99 | +4. Click the `Create pull request` button at the bottom of the form to submit your pull request. |
19 | 100 |
|
20 | | -1. Commit your changes and push them to your forked repository: `git commit -m "Add your idea"` |
21 | | -2. Create a pull request (PR) from a branch that's not the `main` branch in your main repo." |
22 | | -3. In the PR description, provide a comprehensive overview of your contribution using the filled-out Idea Template and reference the issue you are addressing (if applicable). |
23 | | -4. Our team will review your contribution, provide feedback if necessary, and merge it into the main project if it aligns with our goals and standards. |
| 101 | +3. The team will then review your contribution, provide feedback if necessary (you will be notified via email), and merge your contribution into the main project if it aligns with our goals and standards. |
0 commit comments