We warmly welcome contributions from individuals who are passionate about transforming giving through trust and transparency. Whether you're a developer, designer, or community member, your contributi
We warmly welcome contributions from individuals who are passionate about transforming giving through trust and transparency. Whether you're a developer, designer, or community member, your contributions help build the digital infrastructure for transparent, high-impact community funding.
This guide outlines the various ways you can contribute to the Aruuri project, along with our development standards and workflow. For a comprehensive overview of the platform's architecture and vision, please refer to the [Aruuri Platform Overview] page. If you're looking to set up your local development environment, start with [Getting Started with Aruuri Development].
There are several ways to get involved and contribute to Aruuri:
For detailed guidelines on contributing, please refer to our official CONTRIBUTING.md document in the repository.
To maintain a clean and organized Git history, we follow specific branch naming conventions:
feat/: For new features or enhancements.
feat/add-dark-mode, feat/project-creation-flowfix/: For bug fixes.
fix/donation-button-alignment, fix/login-error-messagedocs/: For documentation updates or additions.
docs/update-readme, docs/add-api-referencechore/: For routine maintenance tasks, build process changes, or dependency updates that don't directly modify production code.
chore/upgrade-nextjs, chore/update-eslint-configWe adhere to the Conventional Commits↗ specification for our commit messages. This standard provides a clear and structured way to communicate the intent of each commit, making it easier for reviewers and for generating changelogs.
A conventional commit message should follow this structure:
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
Key Elements:
type: Required. Must be one of feat, fix, docs, chore, style, refactor, test, perf, ci, build, revert.scope: Optional. Indicates the part of the codebase affected (e.g., web, database, ui, utils, infrastructure).description: Required. A concise summary of the change.Examples:
feat(ui): add Dialog componentfix(web): resolve donation flow errordocs(readme): update installation stepschore(deps): update all dependenciesrefactor(database): improve connection pooling logicFor more in-depth information on our commit message standards, please consult docs/COMMIT_CONVENTIONS.md.
To contribute your changes to the main branch, please follow our Pull Request process:
main using one of the branch naming conventions.
main branch.feat(web): Implement user profile page).Thank you for your interest in contributing to Aruuri! Your efforts help us build a more transparent and impactful future for giving.