We’re excited you’re interested in contributing! Please follow these steps to ensure a smooth and efficient collaboration process.
- Create a GitHub account if you don’t already have one.
- Navigate to the repository’s GitHub page.
- Click the Fork button in the top-right corner to create a copy of the repository under your account.
-
Clone the forked repository to your local machine by running the following command:
git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
-
Replace
YOUR_USERNAME
andREPOSITORY_NAME
with your GitHub username and the repository name.
-
Follow branch naming conventions outlined in the Git Guidelines.
-
Create a branch name based on the type of change (e.g.,
feat/name-related-issue
,fix/name-related-issue
).git checkout -b branch-name
Example:
feat/update-readme
orfix/login-bug
.
-
Make changes in your local repository.
-
Follow atomic commit principles:
- Each commit should address a single, logical change.
- Avoid bundling unrelated changes in a single commit.
- Write clear and descriptive commit messages using the format:
git add . git commit -m "type(scope): description"
Examples:
feat(authentication): add support for OAuth login
fix(api): resolve 404 error in user endpoint
docs(readme): update contribution guidelines
- Ensure the project runs correctly after making your changes.
- Follow the project-specific setup instructions to test your changes locally.
-
Push your changes to your forked repository:
git push origin your-branch-name
-
⚠️ Note: This repository uses Husky for pre-push hooks. Husky will automatically runnpm run format
andnpm run lint
before allowing the push.- If you encounter errors, fix any formatting or linting issues before retrying the push.
- Navigate to your forked repository on GitHub.
- Click New Pull Request and select your branch to merge into the
main
of the original repository. - Use the Pull Request Template provided and fill it out properly.
- Follow the Git Guidelines for branch naming, commit messages, and overall contribution standards.
- Make sure your code adheres to the repository’s coding standards.
- Respect the project maintainers' feedback and requested changes.
Thank you for contributing! 🚀✨