|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Request for changes/ Pull Requests |
| 4 | +You first need to create a fork of the [github-issue-template](https://github.com/stevemao/github-issue-templates/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). |
| 5 | + |
| 6 | +Then add your fork as a local project: |
| 7 | + |
| 8 | +```sh |
| 9 | +# Using HTTPS |
| 10 | +git clone https://github.com/stevemao/github-issue-templates.git |
| 11 | + |
| 12 | +# Using SSH |
| 13 | +git clone [email protected]:stevemao/github-issue-templates.git |
| 14 | +``` |
| 15 | + |
| 16 | +> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories) |
| 17 | +
|
| 18 | +Then, go to your local folder |
| 19 | + |
| 20 | +```sh |
| 21 | +cd github-issue-template |
| 22 | +``` |
| 23 | + |
| 24 | +Add git remote controls : |
| 25 | + |
| 26 | +```sh |
| 27 | +# Using HTTPS |
| 28 | +git remote add fork https://github.com/YOUR-USERNAME/proforesight.git |
| 29 | +git remote add upstream https://github.com/proforesight/proforesight.git |
| 30 | + |
| 31 | + |
| 32 | +# Using SSH |
| 33 | +git remote add fork [email protected]:YOUR-USERNAME/proforesight.git |
| 34 | +git remote add upstream [email protected]:proforesight/proforesight.git |
| 35 | +``` |
| 36 | + |
| 37 | +You can now verify that you have your two git remotes: |
| 38 | + |
| 39 | +```sh |
| 40 | +git remote -v |
| 41 | +``` |
| 42 | + |
| 43 | +## Receive remote updates |
| 44 | +In view of staying up to date with the central repository : |
| 45 | + |
| 46 | +```sh |
| 47 | +git pull upstream master |
| 48 | +``` |
| 49 | + |
| 50 | +## Choose a base branch |
| 51 | +Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master. |
| 52 | + |
| 53 | +| Type of change | | Branches | |
| 54 | +| :------------------ |:---------:|----------------------:| |
| 55 | +| Documentation | | `main` | |
| 56 | +| Bug fixes | | `main` | |
| 57 | +| New features | | `main` | |
| 58 | +| New issues models | | `YOUR-USERNAME:patch` | |
| 59 | + |
| 60 | +```sh |
| 61 | +# Switch to the desired branch |
| 62 | +git switch main |
| 63 | + |
| 64 | +# Pull down any upstream changes |
| 65 | +git pull |
| 66 | + |
| 67 | +# Create a new branch to work on |
| 68 | +git switch --create patch/1234-name-issue |
| 69 | +``` |
| 70 | + |
| 71 | +Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the Github-issue-templates repository](https://github.com/Nil-Andreu/postgres-backup/) following the template provided. |
0 commit comments