Contributing to NewPass 🚀🫱🏻🫲🏼
April 27, 2024 · View on GitHub
1. Fork the repo
You can do that by clicking this badge:
2. Pick an issue
What do you want to work on? Choose an issue that you'd like to contribute to.
Workflow:
- Browse NewPass Issues.
- Select or create a new issue that interests you and that you'd like to work to.
- Comment
I'm on iton the issue.
3. Create a feature branch in your fork
For your issue, make a feature branch in your forked NewPass repo.
Create a new branch
You can use the GitHub GUI or open a terminal in your cloned forked NewPass repo and run:
git checkout -b fix-issue-YOUR_ISSUE_NUMBER
Replace "YOUR_ISSUE_NUMBER" with the id/number of your issue.
Let's Dive In
🔨 Workflow:
- Commit your changes.
- Try to follow the SOLID Principles.
- Build and test regularly to ensure existing features remain intact.
- Make sure your changes don't break anything.
❓ Ask Yourself:
- "Is this the simplest approach?"
- "Can I achieve the same with fewer changes?"
- "Does it cover all scenarios?"
- "Is my code robust?"
4. Submit a PR to main branch
By now, you should have committed your changes to your branch and ensured they function properly on an actual Android device. The last task is to initiate a pull request to merge your changes into the main branch of
NewPass