Naija Spell Checker is an Open Source proofreading software for Pidgin English.
The Naija Spell Checker (this repo) is freely available under the MIT license.
This monorepo uses Turborepo
apps/editor/: The Naija spell checker editor websiteapps/chrome-extension/: The Naija spell checker chrome extension
To build all apps and packages, run the following command:
yarn build
To develop all apps and packages, run the following command:
yarn dev
Are we missing any of your favorite features, which you think you can add to it. We invite you to contribute to this project.
To start contributing, follow the below guidelines:
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_user_name>/naija-spell-checker.git
3. Navigate to the project directory 📁 .
cd naija-spell-checker
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/Naija-Guru/naija-spell-checker.git
5. Check the remotes for this repository.
git remote -v
6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
git pull upstream main
7. Create a new branch.
git checkout -b <your_branch_name>
8. Implement your desired changes.
9. Track your changes .
git add .
10. Commit your changes .
git commit -m "Relevant message"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on **compare and pull requests**.
13. Add appropriate title and description to your pull request explaining your changes and efforts done.
14. Click on Create Pull Request.
15. Wait for your submission to be accepted and your PR to be merged.
For more on guideline on contributions check CONTRIBUTING.md
To maintain a safe and inclusive space for everyone to learn and grow, contributors are advised to follow the Code of Conduct.