Contributing Guidelines

Ready to contribute?

Please go through the guidelines below to make your first contribution:

Issues

Always create an issue before creating a pull request.
Always ensure that there is no other open issue similar to the one that you want to create.
Always start working on an issue after getting assigned to it.

Clone the forked repository to your local machine:

git clone https://github.com/<github-username>/Openpedia.git

Navigate to the project directory:
```
cd Openpedia
```
Install all dependencies:
```
npm install
```
Create and switch to a new branch:
```
git switch -c <branch>
```
Launch the application:
```
npm run build
```
Make changes to the project and stage them:
```
git add .
```
Commit the changes:
```
git commit -m "<message>"
```
Push the changes to the correponding remote branch:
```
git push origin <branch>
```
Create a pull request!

If you are adding a resource that belongs to any of these following categories:

The commit message should be:

git commit -m "Docs: Add a resource from <publisher>"

If you are adding a resource that belongs to any of these following categories:

The commit message should be:

git commit -m "Docs: Add <name>"

There can be four types of pull requests on this repository:

Docs: Changes related to the documentation
Chore: Changes related to the codebase, but unrelated to the UI or adding a new feature
UI: Changes related to the UI
Feat: Changes related to adding a new feature

When you are opening a pull request, ensure that you are providing the correct type in the pull request title:

Docs: Add MDN Web Docs