1- # Contributing to PROJECT_NAME
1+ # Contributing to react-router-templates
22
3- Thank you very much for taking your time to contribute to PROJECT_NAME :smiley :
3+ Thank you very much for taking your time to contribute to react-router-templates :smiley :
44
55Following a few guidelines so that others can quickly benefit from your contribution.
66
@@ -10,28 +10,28 @@ Following a few guidelines so that others can quickly benefit from your contribu
1010
1111## Code of Conduct
1212This project and everyone participating in it is governed by this project's
13- [ Code of Conduct] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /tree/main/.github/CODE_OF_CONDUCT.md ) .
14- By participating, you are expected to uphold this code. Please report unacceptable behaviour to ORG_EMAIL
13+ [ Code of Conduct] ( https://github.com/tegonal/react-router-templates /tree/main/.github/CODE_OF_CONDUCT.md ) .
14+ By participating, you are expected to uphold this code. Please report unacceptable behaviour to info@tegonal.com
1515
1616## How to Contribute
17- - Star PROJECT_NAME if you like it.
17+ - Star react-router-templates if you like it.
1818
1919- Need help using a feature?
20- Open a [ new discussion] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /discussions/new?category=q-a )
20+ Open a [ new discussion] ( https://github.com/tegonal/react-router-templates /discussions/new?category=q-a )
2121 and write down your question there and we will get back to you.
2222
2323- Found a bug?
24- [ Open an issue] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /issues/new?template=bug_report.md ) .
24+ [ Open an issue] ( https://github.com/tegonal/react-router-templates /issues/new?template=bug_report.md ) .
2525
2626- Missing a feature?
27- Open a [ new discussion] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /discussions/new?category=ideas )
27+ Open a [ new discussion] ( https://github.com/tegonal/react-router-templates /discussions/new?category=ideas )
2828 and write down your need and we will get back to you.
2929
3030- Found spelling mistakes?
3131 Nice catch 🧐 Please fix it and create a pull request.
3232
3333In any case, if you are uncertain how you can contribute, then contact us via a
34- [ new discussion] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /discussions/new?category=contributor-q-a )
34+ [ new discussion] ( https://github.com/tegonal/react-router-templates /discussions/new?category=contributor-q-a )
3535and we will figure it out together :smile :
3636
3737## Your First Code Contribution
@@ -43,8 +43,8 @@ The following are a few guidelines on how we suggest you start.
43432 . Read up the [ Pull Request Checklist] ( #pull-request-checklist )
4444
4545Perfect, you are setup and ready to go.
46- Have a look at [ help wanted issues] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 )
47- where [ good first issues] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 )
46+ Have a look at [ help wanted issues] ( https://github.com/tegonal/react-router-templates /issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 )
47+ where [ good first issues] ( https://github.com/tegonal/react-router-templates /issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 )
4848are easier to start with.
4949Please write a comment such as ` I'll work on this ` in the issue,
5050this way we can assign the task to you (so that others know there is already someone working on the issue)
@@ -58,15 +58,15 @@ Dealing with Git for the first time? Here are some recommendations for how to se
5858 should be descriptive of the issue or the change being made, e.g ` #108-path-exists ` .) Working
5959 on a new branch makes it easier to make more than one pull request.
6060- add this repository as a remote repository using
61- ` git remote add upstream https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB .git ` . You will use this to
61+ ` git remote add upstream https://github.com/tegonal/react-router-templates .git ` . You will use this to
6262 fetch changes made in this repository.
6363- to ensure your branch is up-to-date, rebase your work on
6464 upstream/main using ` git rebase upstream/main ` or ` git pull -r upstream main ` .
6565 This will add all new changes in this repository into your branch and place your
6666 local unpushed changes at the top of the branch.
6767
6868You can read more on Git [ here] ( https://git-scm.com/book/ ) .
69- Contact us via a [ new discussion] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /discussions/new?category=contributor-q-a )
69+ Contact us via a [ new discussion] ( https://github.com/tegonal/react-router-templates /discussions/new?category=contributor-q-a )
7070whenever you need help to get up and running or have questions.
7171
7272* Create a Draft*
@@ -82,12 +82,12 @@ Finally, when you think your PR (short for pull request) is ready, then please:
8282
83831 . read the [ Pull Request Checklist] ( #pull-request-checklist )
84842 . Create your first pull-request
85- 3 . 👏👏👏 you have submitted your first code contribution to ORG_NAME_GITHUB/PROJECT_NAME_GITHUB 😊
85+ 3 . 👏👏👏 you have submitted your first code contribution to tegonal/react-router-templates 😊
8686
8787
8888## Pull Request Checklist
8989Please make sure you can check every item on the following list before you create a pull request:
90- - [ ] your pull request is rebased on the [ latest commit on main] ( https://github.com/ORG_NAME_GITHUB/PROJECT_NAME_GITHUB /commits/main )
90+ - [ ] your pull request is rebased on the [ latest commit on main] ( https://github.com/tegonal/react-router-templates /commits/main )
9191- [ ] Your pull request addresses only “one thing”. It cannot be meaningfully split up into multiple pull requests.
9292- [ ] There is no error if you run ./scripts/before-pr.sh
9393- [ ] Make sure you have no changes after running ./scripts/before-pr.sh and ` git commit --amend ` otherwise
0 commit comments