First off, thank you for considering contributing! π
We welcome contributions that improve the Home Alliance Passport project, whether they are bug fixes, feature requests, documentation updates, or process improvements.
To contribute to this project, follow these steps in order:
-
Fork the Repository
Click the Fork button at the top right of this repository to create your own copy. -
Clone Your Fork
git clone https://github.com/YOUR_USERNAME/Home-Alliance-Passport.git cd Home-Alliance-Passport -
Create a Branch
Follow a descriptive naming convention, for example:
git checkout -b feature/add-ci-badge -
Make Changes
- Keep changes small and focused.
- Write clear commit messages, for example:
git commit -m "Add CI badge to README"
-
Push and Open a Pull Request
git push origin feature/add-ci-badge
Then open a Pull Request (PR) from your fork into this repoβsmainbranch.
Before submitting a PR, please confirm the following:
- Code compiles and runs (
npm start) - Tests pass locally (
npm test) - Documentation is updated if needed
- PR includes a clear description of changes
- Screenshots/logs are attached if UI or output changed
Home-Alliance-Passport/
βββ src/ # Source code
βββ tests/ # Unit & integration tests
βββ docs/ # Documentation
βββ .github/ # Workflows, templates, CODEOWNERS
βββ package.json # NPM config & scripts
βββ README.md # Project overview
Please see SECURITY.md for reporting vulnerabilities.
Do not disclose security issues publicly.
By contributing, you agree to follow respectful collaboration practices.
(A formal CODE_OF_CONDUCT.md can be added later.)
Thanks for helping improve Home Alliance Passport! Every contribution counts.