Thank you for considering to contribute to Surfbird, whether it is a simple bug report or an entire feature you might have planned out, everything is appreciated and welcome!
Do you have a question regarding Surfbird or a specific problem with something? if there is no issue for it yet, please open one!
If you think you've found a bug in Surfbird, please search through all issues before opening another one!
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, maybe even include a screenshot, the more the better!
Awesome! You can follow our Development Setup guide to set up a development environment for Surfbird!
Once the setup is up and running, you're ready to implement your feature or fix.
- Fork the repository
- Create a branch for your changes
- Use Git Flow-like
feature/orfix/prefixes for your branch names - Try to keep the branch names short, but on topic
- If an issue exists, prepend the issue ID to your branch name
- Example:
feature/12-locales
- Use Git Flow-like
- Commit your changes into the branch
- Follow the conventional commits style for your commit messages
- To easily follow the commit message standard, you can use
npm run commitafter you added your files
- To easily follow the commit message standard, you can use
- This project uses ESLint for linting. Please ensure that your code follows the Standard formatting style, and is well linted.
- Follow the conventional commits style for your commit messages
Almost ready to open that Pull Request! But before we hop into the action, please ensure that you are up-to-date with the master branch!
git remote add upstream [email protected]:surfbirdapp/surfbird.git
git checkout master
git pull upstream master
Then update your feature branch from your local copy of master, and push it!
git checkout feature/12-locales
git rebase master
git push --set-upstream origin feature/12-locales
Now you're ready to submit your Pull Request!
After your Pull Request has been checked by a maintainer and everything is okay, it will get merged into the upstream code.
If there are any issues or other kind of feedback, you will notice in follow-up discussion around your Pull Request.
Once everything has been cleared up, your fix or feature is ready to be shipped. Well done, you finished your contribution!
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
This project and everyone participating in it is governed by the Surfbird Code of Conduct. By participating, you are expected to uphold this code.
This Contribution Guideline is inspired by activeadmin, taking some key aspects and explanations from it!
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
Thank you to all the people who have already contributed to surfbird!
Thank you to all our backers! [Become a backer]
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)
