A guide that everyone must follow to make contributions to this repository. If you don't have git on your machine, install it. Below is a basic guide to help you get started, if you're new to git, GitHub, and contributing to a repository, we've set up a repo to make your first contribution as easy as possible.
- Fork this repository.
- Clone the forked repository.
- Create a branch.
- Make necessary changes and commit those changes.
- Push changes to GitHub.
- Submit your changes for review by making a Pull Request, use template.
- Follow Code of Conduct and Contribution Guidelines.
If you've completed all the tasks as requested, all your changes will be merged into the main branch of this project. You will get a notification email once the changes have been merged and you'll officially be a contributor.
- Make sure your editor supports formatting with Prettier, and format according to
.prettierrcfile before committing. - Use Conventional Commits for commit messages.
- Use GitHub Flow for branching and use Pull Request Template for pull requests.
- Open pull requests for one issue or feature at a time.
- Don't stack Pull Requests. Always create a new branch from the default branch (like main), not from another feature branch.
- When working on an issues, link the issue number to the pull request using the Pull Request Template
- Try to keep your pull request to a single, meaningful commit. Squash commits if necessary before submission.
- Before starting work, ask a maintainer to assign you the issue on the very own issue comment to avoid duplicate efforts and PRs.
If you're contributing in the month of October, you can also participate in the Hacktoberfest event. Once you're registered there and have merged PRs with us, you'll be eligible to receive a free SWAG from BOSC.
Note: Only the Top contributor will be eligible for the BOSC-SWAG, this Hacktoberfest-2025