You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# How to contribute to React Developers Kenya (Reactdevske) Website
2
2
3
3
Please note we have a [code of conduct](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
4
4
5
5
## Contributing procedure
6
6
7
-
### Submit an issue
7
+
### Find an issue to work on
8
+
9
+
- You can contribute to this project by either creating an issue or by checking out the open issues available.
10
+
11
+
#### 1. Submit an issue
8
12
9
13
- Create a [new issue](https://github.com/reactdeveloperske/reactdevske-website/issues)
10
14
- Comment on the issue (if you'd like to be assigned to it) - that way the issue can be assigned to you.
11
15
12
-
### Open issues
16
+
#### 2. Open issues
13
17
14
18
- Go to [open issues](https://github.com/reactdeveloperske/reactdevske-website/issues)
15
19
- select an issue of your choice that is `open` or `need help` or is `up-for-grabs` and is not assigned.
@@ -19,7 +23,7 @@ Please note we have a [code of conduct](https://github.com/reactdeveloperske/rea
19
23
20
24
- If you're not sure, here's how to [fork the repo](https://help.github.com/en/articles/fork-a-repo)
21
25
22
-
### Set up your local environment (optional)
26
+
####Set up your local environment (optional)
23
27
24
28
If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.
25
29
@@ -34,38 +38,34 @@ If you're ready to contribute and create your PR, it will help to set up a local
34
38
35
39
If this is your first time forking our repo, this is all you need to do for this step:
36
40
37
-
```
38
-
$ git clone git@github.com:[your_github_handle]/reactdevske-website.git && cd reactdevske-website
Make sure you checkout the `develop` branch `git checkout develop`
45
+
Make sure you checkout the `develop` branch by running the command `git checkout develop`
42
46
43
-
If you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.
47
+
If you've already forked the repo and created the develop branch, you'll want to ensure your fork and your develop branch is configured and that it's up to date. This will save you the headache of potential merge conflicts.
44
48
45
49
To [configure your fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork):
You may have noticed some error about providing a form key. This is because we use [Formspree](https://formspree.io/) to handle our contact form. To get around this, you can:
96
+
97
+
- Use your own [Formspree](https://formspree.io/) account and set the `FORMSPREE_KEY` environment variable to your key. (refer to the .env.example file for guidance on where to put your formspee key).
98
+
99
+
You may have also noticed a second error about missing required parameters: sitekey. This is because we use [reCAPTCHA](https://www.google.com/recaptcha/about/) to prevent spam. To get around this, you can:
100
+
101
+
- Use your own [reCAPTCHA](https://www.google.com/recaptcha/about/) account and set the `RECAPTCHA_SITE_KEY` environment variable to your keys. (refer to the .env.example file for guidance on where to put your recaptcha site key).
102
+
103
+
Both of these changes will require you to create a `.env` file in the root directory of the project. You can copy the contents of the `.env.example` file and paste them into the `.env` file. Then, you can add your keys to the appropriate variables.
104
+
105
+
---
98
106
99
107
<br>
100
108
109
+
3. Make changes to the codebase
110
+
101
111
- Open this directory in your favorite text editor / IDE, and see your changes live by visiting `localhost:3000` from your browser
102
112
- Pro Tip: Explore scripts within `package.json` for more build options
113
+
- Pro Tip: Use [Prettier](https://prettier.io/) to format your code before committing by running `npm run prettier:check` and `npm run prettier:format` to check and fix formatting issues
103
114
104
-
1. Add changes made to the repo addressing an issue
105
-
```
115
+
4. Add changes made to the repo addressing an issue
116
+
117
+
```bash
106
118
git add [file_name]
107
119
```
108
-
2. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see [how to link a commit message to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
109
120
110
-
```
111
-
$ git commit -m "brief description of changes [Fixes #1234]"
121
+
5. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see [how to link a commit message to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
122
+
123
+
```bash
124
+
git commit -m "brief description of changes [Fixes #1234]"
112
125
```
113
126
114
-
1. Push to your GitHub account
127
+
6. Push to your GitHub account
115
128
116
-
```
117
-
$ git push -u origin [feature_branch]
129
+
```bash
130
+
git push -u origin [feature_branch]
118
131
```
119
132
120
133
### Submit your Pull Request (PR)🚀
121
134
122
135
- After your changes are commited to your GitHub fork, submit a pull request (PR) to the `develop` branch of the `reactdeveloperske/reactdevske-website` repo
123
136
- In your PR description, reference the issue it resolves (see [linking a pull request to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
124
137
- ex. `Updates out of date content [Fixes #1234]`
138
+
139
+
### Sit back, relax and wait for your PR to be reviewed/merged
140
+
141
+
- We'll review your PR as soon as possible
142
+
- We may suggest some changes or improvements or alternatives.
0 commit comments