Welcome to the wwWallet ecosystem! We’re thrilled that you’re interested in contributing. This document provides guidelines for contributing to the project, whether you're submitting code, reporting issues, or participating in discussions.
Our project thrives on collaboration, so don’t hesitate to reach out and engage with us through GitHub Discussions or by filing issues and pull requests.
To contribute effectively, follow these steps:
-
Start with an issue:
- For larger or high-impact changes, contact us first to coordinate and gain consensus. This might involve starting a conversation in our Discussions or reaching out through other appropriate channels. We'll work together to determine the best way to proceed.
- For actionable changes, use the issue templates provided in our repositories to file a bug report, feature request or other relevant issue. The templates guide you in providing the necessary information.
-
Create a branch:
- Create a branch corresponding to the issue or task. If multiple repositories are affected, create branches in each.
-
Commit your changes:
- Write meaningful commit messages that reference the issue number and type of change (e.g.,
feat,fix,docs), such as:docs: Update README, closes #45
- Write meaningful commit messages that reference the issue number and type of change (e.g.,
-
Submit a pull request:
- Open a pull request (PR) referencing the relevant issue. Include a description of the change and any additional context.
- Ensure it adheres to the Pull Request Guidelines.
-
Participate in the review process:
- Reviewers may suggest changes or improvements. Collaborate to address feedback.
- If there are merge conflicts, resolve them promptly.
-
Monitor CI tests:
- Ensure your PR passes all automated tests. Fix any failures by pushing updates to your branch.
-
Use one PR per bug fix or feature:
- Keep your changes focused. Avoid mixing unrelated fixes or features in the same pull request, as this can significantly increase the time needed for review and may delay or prevent us from merging.
-
Coordinate bigger changes:
- For non-trivial or high-impact changes, discuss your approach with maintainers in advance. This prevents unnecessary work and ensures alignment with project goals.
-
Respect architectural decisions:
- Even small changes that deviate from the current architecture or design patterns should be discussed and gain consensus first. The core team maintains this project and its forks, so they need to stay familiar with all decisions and ensure consistency across the codebase. Sometimes, existing code—even if imperfect—aligns better with the overall architecture for reasons like maintainability or compatibility.
-
Small contributions:
- For minor fixes (e.g., typos, metadata updates, comment improvements), you can directly open a merge request without creating a separate issue.
-
Templates for issues and PRs:
- Utilize our pre-defined templates when opening issues or submitting pull requests. These templates help streamline communication and ensure all necessary details are provided.
Each contribution is reviewed by the core developers of wwWallet to ensure quality and alignment with the project’s goals.
During a code review, we:
- Assess the change’s desirability:
- For larger features, ensure prior discussion has occurred.
- Review commit structure:
- Ensure commits are logically grouped and have clear, descriptive messages.
- Verify code quality:
- All changes should adhere to the project’s style and quality standards.
Code reviews are an opportunity to share knowledge and ensure consistency across the project. Please be receptive to feedback and work collaboratively with reviewers.
Thank you for helping make the wwWallet ecosystem better! We value your time and effort and look forward to your contributions. 🚀