Skip to content

Commit

Permalink
Update references from yarn to npm
Browse files Browse the repository at this point in the history
  • Loading branch information
EmmaDawsonDev committed Jun 29, 2024
1 parent 37999b9 commit a219541
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 17 deletions.
6 changes: 3 additions & 3 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
tasks:
- name: yarn
init: yarn install
command: yarn dev
- name: npm
init: npm install
command: npm run dev
# List the ports to expose. Learn more https://www.gitpod.io/docs/config-ports/
ports:
- port: 3000
Expand Down
44 changes: 30 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ This project is built with Next.JS, Typescript and CSS modules.

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

[Node.js](https://nodejs.org/en/)
[Yarn Package Manager](https://yarnpkg.com/)
[Node.js](https://nodejs.org/en/)

## Available packages

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

## How to contribute

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.
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.
2. Please check the [coding standards](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/CODING_STANDARDS.md) page before start contributing.
3. [Fork](https://github.com/AccessibleForAll/AccessibleWebDev/fork) the project
4. Clone the project:
3. [Fork](https://github.com/AccessibleForAll/AccessibleWebDev/fork) the project
4. Clone the project:

```bash
git clone https://github.com/<your-github-username>/AccessibleWebDev
```
5. Navigate to the project directory:

5. Navigate to the project directory:

```bash
cd AccessibleWebDev
```
6. Set the upstream repository:

6. Set the upstream repository:

```bash
git remote add upstream https://github.com/AccessibleForAll/AccessibleWebDev.git
```
7. Install dependencies:

7. Install dependencies:

```bash
yarn install
npm install
```
8. Create a new branch:

8. Create a new branch:

```bash
git checkout -b <YourBranchName>
```
9. To run the whole project locally:

9. To run the whole project locally:

```bash
yarn dev
npm run dev
```

10. Make your changes
10. Make your changes
11. Stage your changes:

```bash
git add <NameOfFileChanged>
```

12. Commit your changes and provide a meaningful commit message:

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.)

```bash
git commit -m "<Your commit message here>"
```

13. Push your commits to your local repository

```bash
git push origin <YourBranchName>
```

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)
15. Wait for maintainers to review your pull request and suggest any changes

Expand Down

0 comments on commit a219541

Please sign in to comment.