Contributing
Before you start, read the coding guidelines to make sure your code follows the project conventions.
Steps
1 Clone the Main Branch
git clone git@github.com:HydredIN/<repository-name>
cd <repository-name>
2 Create a New Branch
git checkout -b feature/your-feature-name
3 Make Your Changes
Review the coding guidelines and then make your changes.
4 Run Formatting & Lint Checks
pnpm prettier:write
pnpm lint
5 Commit Your Changes
git add .
git commit -S -m "feat: describe your change"
6 Push Your Branch
git push origin feature/your-feature-name
7 Open a Pull Request
Open a pull request against the main branch of the repository on GitHub:
Commit Message Format
Use clear and descriptive commit messages:
feat: add job listing filter
fix: resolve ghost-proof timer bug
docs: update contributing guidelines
chore: upgrade dependencies
| Prefix | When to use |
|---|---|
feat | adding a new feature |
fix | fixing a bug |
docs | documentation changes |
chore | maintenance, upgrades |
refactor | code change with no feature or fix |
style | formatting, missing semicolons, etc |
Reporting Issues
If you find a bug or have a feature request, create an issue in the relevant repository under the Hydred GitHub organisation: