Thank you for your interest in contributing to Squadbox! 😍 ❤️ 📬
Squadbox is a tool to help people who are being harassed online by having their friends (or “squad”) moderate their messages.
This documents is a set of guidelines for contributing to Squadbox on GitHub, and details our expectations for contributors, our workflow, and how we communicate. This guide is meant to make it easy for you to get involved!
- Participation guidelines
- What we're working on
- How to contribute
- How to report bugs
- Communication channels
This project adheres to a code of conduct. By participating, you are expected to uphold this code! Please report unacceptable behavior to [email protected].
Our main goal right now is to get Squadbox in solid shape to release it widely to the public. We've only tested with a small number of users so far and there are many areas we need to improve. Take a look at the issues in our current milestone or browse some good first issues to get started!
After that, we hope to build integrations for Squadbox to be used with other communication platforms besides email.
- Comment on the issue and introduce yourself! Let us know you're working on it, so we don't duplicate work. This will also be a good time for you to ask us any questions you may have about the issue and for us to provide additional context to you.
- Fork this repository. This makes your own version of this project you can edit and keep in sync with the main one.
- Check out a new branch on your fork of the repository. Give it a descriptive name, like "readme-update" or "reply-bug". Make your changes on that branch. (If you're working on a coding issue, follow the coding setup instructions to get all set up on your computer.
- Commit your changes. Use a descriptive commit message!
- Submit a pull request to merge your changes into the master branch. This opens a discussion around your changes and lets us know you are proposing them!
First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.
Anything seem weird or wrong? Please file any bugs, requests, or questions by creating a new issue in our issue tracker. Please be as descriptive as possible and include screenshots and steps to reproduce the bug if applicable!
We have a mailing list for discussing the project, which you can join here. If you want to reach out to the project leads only, send us an email at [email protected].