How to Contribute
Setting Expectations
I'm sharing more context about me and the project to help you decide on your level of investment in this project.
For better or worse, I refuse to stop working on Compass. However, I'm currently working full-time as a Software Engineer for another company, which means it might take me a few days to get back to you.
Timeline
In the short-term, we're focused on making Compass more stable and easier to use.
In the medium-term, we'll add some low-effort features that'll make Compass stand out from the competition.
Long-term, we'll turn Compass into a bootstrapped business that operates for decades.
What's in it for you
What I can't currently offer to contributors:
- ❌ Compensation
- ❌ Immediate responses
What I guarantee:
- 🏆 Recognition (GitHub, changelogs, etc)
What I'm open to offering:
- 📝 Recommendation letter / reference for your next job (upon request)
- 📈 Preference for future opportunities @ Switchback
If you're still interested in making the project better, thank you in advance!!
Next Steps
🏁 You're ready to get started
- Go to the project dashboard: https://github.com/orgs/SwitchbackTech/projects/2
- Find an issue in the 'Todo' column that interests you
- Ask any clarifying questions in the issue thread
- Leave a comment saying you're working on this issue to avoid duplicate work
- Fork the repository
- Create a new branch with a descriptive name
- Make your changes
- Push your branch to your fork
- Create a pull request
- Wait for feedback, picking up another issue in the meantime if you'd like
🐞 You found an undocumented bug
- If the bug is a security vulnerability, please report it here.
- Ensure the bug was not already reported by searching under the issues
- If it's a new bug, open a new issue, including as much relevant information as possible.
☝️ You want to add a new feature or change an existing one
If you'd like to contribute a larger feature or fix, please create a GitHub issue to discuss the change and get the 👍 before submitting a pull request. This will ensure that we're on the same page and that your work will be accepted.
💅 You fixed whitespace, formatted code, or made a purely cosmetic patch
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted.