Skip to content

Commit 9dede4f

Browse files
authored
Update CONTRIBUTING.md
1 parent 7d729de commit 9dede4f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can use the current running API URL as the value to `CONTRIBUTIONS_API_URL`
1818
5. [Run the project locally](https://github.com/jordanopensource/contributions-web/blob/main/CONTRIBUTING.md#running-the-project-locally).
1919
6. Check current [issues](https://github.com/jordanopensource/contributions-web/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest),
2020
and if you're a beginner, you can [filter issues with `good first issues` label](https://github.com/jordanopensource/contributions-web/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest+label%3A%22good+first+issue%22).
21-
If you decide to work on one of the issue, write a comment on the issue asking to be assigned to it.
21+
If you decide to work on one of the issue, write a comment on the issue asking to be assigned to it.
2222
_Do not work on issues that you're not assigned to in order to avoid duplicate work_.
2323
7. Create a new branch from `development` branch for the task that you want to work on:
2424
`git checkout -b <prefix>/branch-title`
@@ -36,25 +36,25 @@ _Do not work on issues that you're not assigned to in order to avoid duplicate w
3636
```
3737

3838
8. Write descriptive and concise commit messages
39-
A commit message should describe the changes made in the commit in a clear and concise way. Follow these guidelines when writing commit messages:
40-
- Limit the first line of the commit message to 72 characters or less.
41-
- Use the imperative mood and present tense in the subject line, e.g. "Fix typo in the homepage" instead of "Fixed typo...".
42-
- Use the body of the commit message to provide additional context or details, _if necessary_.
43-
- Use bullet points in the body of the commit message to break down changes, _if necessary_.
39+
Follow these guidelines when writing commit messages:
40+
- Limit the first line of the commit message to 72 characters or less.
41+
- Use the imperative mood and present tense in the subject line, e.g. "Fix typo in the homepage" instead of "Fixed typo...".
42+
- Use the body of the commit message to provide additional context or details, _if necessary_.
43+
- Use bullet points in the body of the commit message to break down changes, _if necessary_.
4444

4545
9. Push to your branch and then make a pull request from your branch to the base `development`.
4646

4747
### Running the Project Locally
4848

4949
#### Using Docker
5050
Make sure that [docker](https://docs.docker.com/engine/install/) is installed on your system
51-
and then run the project locally using [docker compose](https://github.com/jordanopensource/contributions-web/blob/development/docker-compose.yaml) with this command:
51+
and then run the project locally using [docker compose](https://github.com/jordanopensource/contributions-web/blob/development/docker-compose.yaml) with this command:
5252
`docker compose up`.
5353

5454
#### Using Node:
5555
1. Make sure [Node](https://nodejs.org/en) v16 is installed. Alternatively, you can use [NVM](https://github.com/nvm-sh/nvm#installing-and-updating) to install any node version.
5656
2. Navigate to the project directory and run `npm i` to install the dependancies.
57-
3. Run the project in development mode by running `npm run dev`.
57+
3. Run the project in development mode by running `npm run dev`. You can now preview the project on port 3000 by visiting http://localhost:3000/ in your browser.
5858

5959
## Issues and Features Requests
6060

0 commit comments

Comments
 (0)