Ready to contribute?
Please go through the guidelines below to make your first contribution:
- Issues
- Pull Requests
- Creating a Pull Request
- Style Guide for Commit Messages
- Style Guide for Pull Requests
- 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.
- Each pull request should contain a single logical change.
- The pull request title should summarize the changes made in it.
- Describe the changes made in the pull request to the best of your ability.
- The pull request should be linked to the corresponding issue.
-
Fork the repository
-
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:
- Introduction to Open Source
- Learn Git and GitHub
- Contributing to Open Source
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:
- Beginner-Friendly Repos
- Open Source Programs
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 documentationChore
: Changes related to the codebase, but unrelated to the UI or adding a new featureUI
: Changes related to the UIFeat
: 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