Skip to main content

Contribute

Setting Expectations​

I'm sharing more context about the project to help you decide on your level of investment in this project.

Short-term, we're focused on turning Compass into a minimal, yet reliable app.

Medium-term, we'll build on that foundation to make Compass into a unique and premium product that helps people make better decisions.

Long-term, Compass will become a bootstrapped business that operates for decades.

What's in it for you​

What I guarantee:

  • 🏆 Recognition (GitHub, changelogs, etc)

What I'm open to offering:

  • 📝 Reference for your next job (upon request)
  • 📈 Preference for future opportunities @ Switchback
  • 📈 Compensation

Workflows​

🏁 You're ready to pick up a new task​

  1. Go to the backlog
  2. Find an issue in the 'Ready' column that interests you. If this is your first time contributing, look for issues with the good first issue label. If there are multiple good first issues, pick the one with the highest priority tag (in order of priority: P0 then P1 then P2).
  3. Ask any clarifying questions in the issue thread
  4. Leave a comment saying you're working on this issue to avoid duplicate work
  5. Fork the repository
  6. Create a new branch with a descriptive name
  7. Make your changes
  8. Push your branch to your fork
  9. Create a pull request
  10. 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.