Thank you for your interest in contributing to Talawa Admin. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.
If you are new to contributing to open source, please read the Open Source Guides on How to Contribute to Open Source.
Please read the Palisadoes Contributing Guidelines.
For detailed information about testing, linting, formatting, and code coverage, please refer to our comprehensive Testing Guide.
Testing:
- Run all tests:
pnpm run test - Run specific test:
pnpm run test /path/to/test/file - Run with coverage:
pnpm run test:coverage - Run with sharding:
pnpm run test:shard
Linting and Formatting:
- Fix linting issues:
pnpm run lint:fix - Fix formatting issues:
pnpm run format:fix - Check linting:
pnpm run lint:check - Check formatting:
pnpm run format:check
Cypress E2E Testing:
- See the Cypress Guide for end-to-end testing
For complete documentation including test sharding, code coverage setup, debugging, and git hooks, visit the Testing Guide.
- After making changes you can add them to git locally using
git add <file_name>(to add changes only in a particular file) orgit add .(to add all changes). - After adding the changes you need to commit them using
git commit -m '<commit message>'(look at the commit guidelines below for commit messages). - Once you have successfully commited your changes, you need to push the changes to the forked repo on github using:
git push origin <branch_name>.(Here branch name must be name of the branch you want to push the changes to.) - Now create a pull request to the Talawa-admin repository from your forked repo. Open an issue regarding the same and link your PR to it.
- Ensure the test suite passes, either locally or on CI once a PR has been created.
- Review and address comments on your pull request if requested.