Skip to content

Commit 6eb2cb9

Browse files
Merge pull request #400 from AccessibleForAll/chore/update_contributing_guidelines
Chore: Update references from yarn to npm
2 parents 37999b9 + a219541 commit 6eb2cb9

File tree

2 files changed

+33
-17
lines changed

2 files changed

+33
-17
lines changed

.gitpod.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
22
tasks:
3-
- name: yarn
4-
init: yarn install
5-
command: yarn dev
3+
- name: npm
4+
init: npm install
5+
command: npm run dev
66
# List the ports to expose. Learn more https://www.gitpod.io/docs/config-ports/
77
ports:
88
- port: 3000

CONTRIBUTING.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ This project is built with Next.JS, Typescript and CSS modules.
66

77
## Pre-requisites (these need to be installed on your machine)
88

9-
[Node.js](https://nodejs.org/en/)
10-
[Yarn Package Manager](https://yarnpkg.com/)
9+
[Node.js](https://nodejs.org/en/)
1110

1211
## Available packages
1312

@@ -17,49 +16,66 @@ Translations - [next-i18next Documentation](https://next.i18next.com/)
1716

1817
## How to contribute
1918

20-
1. Look through [Pre-existing issues](https://github.com/AccessibleForAll/AccessibleWebDev/issues) or [Raise a new issue](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new/choose) and ask to be assigned. Pull requests made without a corresponding issue will likely be closed.
19+
1. Look through [Pre-existing issues](https://github.com/AccessibleForAll/AccessibleWebDev/issues) or [Raise a new issue](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new/choose) and ask to be assigned. Pull requests made without a corresponding issue will likely be closed.
2120
2. Please check the [coding standards](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/CODING_STANDARDS.md) page before start contributing.
22-
3. [Fork](https://github.com/AccessibleForAll/AccessibleWebDev/fork) the project
23-
4. Clone the project:
21+
3. [Fork](https://github.com/AccessibleForAll/AccessibleWebDev/fork) the project
22+
4. Clone the project:
23+
2424
```bash
2525
git clone https://github.com/<your-github-username>/AccessibleWebDev
2626
```
27-
5. Navigate to the project directory:
27+
28+
5. Navigate to the project directory:
29+
2830
```bash
2931
cd AccessibleWebDev
3032
```
31-
6. Set the upstream repository:
33+
34+
6. Set the upstream repository:
35+
3236
```bash
3337
git remote add upstream https://github.com/AccessibleForAll/AccessibleWebDev.git
3438
```
35-
7. Install dependencies:
39+
40+
7. Install dependencies:
41+
3642
```bash
37-
yarn install
43+
npm install
3844
```
39-
8. Create a new branch:
45+
46+
8. Create a new branch:
47+
4048
```bash
4149
git checkout -b <YourBranchName>
4250
```
43-
9. To run the whole project locally:
51+
52+
9. To run the whole project locally:
53+
4454
```bash
45-
yarn dev
55+
npm run dev
4656
```
4757

48-
10. Make your changes
58+
10. Make your changes
4959
11. Stage your changes:
60+
5061
```bash
5162
git add <NameOfFileChanged>
5263
```
64+
5365
12. Commit your changes and provide a meaningful commit message:
54-
66+
5567
Unsure how to write a meaningful commit message? Check out this article about [How to Write a Good Git Commit Message](https://blog.ossph.org/how-to-write-a-good-git-commit-message/#:~:text=To%20set%20up%20a%20Git,t%20meet%20the%20specified%20format.)
68+
5669
```bash
5770
git commit -m "<Your commit message here>"
5871
```
72+
5973
13. Push your commits to your local repository
74+
6075
```bash
6176
git push origin <YourBranchName>
6277
```
78+
6379
14. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
6480
15. Wait for maintainers to review your pull request and suggest any changes
6581

0 commit comments

Comments
 (0)