4.5 KiB
Contributing to Parse SDK for Android
We want to make contributing to this project as easy and transparent as possible.
Code of Conduct
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Our Development Process
Most of our work will be done in public directly on GitHub. There may be changes done through our internal source control, but it will be rare and only as needed.
master is unsafe
Our goal is to keep master stable, but there may be changes that your application may not be compatible with. We'll do our best to publicize any breaking changes, but try to use our specific releases in any production environment.
Pull Requests
We actively welcome your pull requests. When we get one, we'll run some Parse-specific integration tests on it first. From here, we'll need to get a core member to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.
- Fork the repo and create your branch from
master. - Add unit tests for any new code you add.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
Complete your CLA here: https://developers.facebook.com/opensource/cla
Bugs
Although we try to keep developing on Parse easy, you still may run into some issues. Technical questions should be asked on Stack Overflow, and for everything else we'll be using GitHub issues.
Known Issues
We use GitHub issues to track public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
Reporting New Issues
Not all issues are SDK issues. If you're unsure whether your bug is with the SDK or backend, you can test to see if it reproduces with our REST API and Parse API Console. If it does, you can report backend bugs here.
To view the REST API network requests issued by the Parse SDK and responses from the Parse backend, please check out OkHttp Interceptors. With this tool, you can either log network requests/responses to Android logcat, or log them to Chrome Debugger via Stetho.
Details are key. The more information you provide us the easier it'll be for us to debug and the faster you'll receive a fix. Some examples of useful tidbits:
- A description. What did you expect to happen and what actually happened? Why do you think that was wrong?
- A simple unit test that fails. Refer here for examples of existing unit tests. See our README for how to run unit tests. You can submit a pull request with your failing unit test so that our CI verifies that the test fails.
- What version does this reproduce on? What version did it last work on?
- Stacktrace or GTFO. In all honesty, full stacktraces with line numbers make a happy developer.
- Anything else you find relevant.
Security Bugs
Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
Style Guide
We're still working on providing a code style for your IDE and getting a linter on GitHub, but for now try to keep the following:
- Most importantly, match the existing code style as much as possible.
- Try to keep lines under 100 characters, if possible.
License
By contributing to Parse Android SDK, you agree that your contributions will be licensed under its license.