So you're interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.
There are lots and lots of ways to get involved, this document covers:
- Raising issues
- Report a bug
- Suggest enhancements
- Working on Butter
- The guidelines
- Translate
- Build and debug
- Updating with the latest changes
If you're about to raise an issue because you think that you've found a problem with Butter, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first.
The GitHub issue tracker is the preferred channel for bug reports, feature requests, change requests and submitting pull requests, but please respect the following restrictions:
-
Please search for existing issues. Help us keep duplicate issues to a minimum by checking to see if someone has already reported your problem or requested your idea.
-
Please do not use the issue tracker for personal support requests (use the github issues or IRC - #butterproject on freenode).
-
Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — try to reproduce it using the latest
masteror look for closed issues. -
Include a screencast if relevant - Is your issue about a design or front end feature or bug? The most helpful thing in the world is if we can see what you're talking about. Just drop the picture after writing your issue, it'll be uploaded and shown to the developpers.
-
Use the Issue tab on Github to start creating a bug report. A good bug report shouldn't leave others needing to chase you up for more information. Be sure to include all the possible required details and the steps to take to reproduce the issue.
Feature requests are welcome. Before you submit one be sure to:
- Use the Github Issues search and check the feature hasn't already been requested.
- Take a moment to think about whether your idea fits with the scope and aims of the project, or if it might better fit being an app/plugin.
- Remember, it's up to you to make a strong case to convince the project's leaders of the merits of this feature. Please provide as much detail and context as possible, this means explaining the use case and why it is likely to be common.
- Clearly indicate whether this is a feature request for the application itself, or for packages like Providers, Metadatas, or other.
You're welcome to work with us and the community to build the application and take it to new highs!
Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug. This makes it more likely that there will be enough information available for your PR to be properly tested and merged. To make sure your PR is accepted as quickly as possible, you should be sure to have read all the guidelines on:
Translations are NOT submitted directly through this git repository. To sumbit translations, please sign-up in Transifex
Want to build yourself to practice and discover how the magic happens? Or maybe you have developped new code and wonder how to distribute a test binary?
- Clone the git repo, to get the Butter source code
cdinto the project folder- Run
yarn- to get all the dependencies - Run
yarn build
Pulling down the latest changes from master will often require more than just a pull, you may also need to do one or more of the following:
yarn- fetch any new dependenciesyarn build- rebuildyarn run start- launches the application