forked from zelo72/mastodon-ios
30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
- File the issue for bug report and feature request
|
||
|
|
- Translate the project in our [Crowdin](https://crowdin.com/project/mastodon-for-ios) project
|
||
|
|
- Make the Pull Request to contribute
|
||
|
|
|
||
|
|
## Bug Report
|
||
|
|
File the issue about the bug. Make sure you are installing the latest version app from TestFlight or App Store.
|
||
|
|
|
||
|
|
## Translation
|
||
|
|
[](https://crowdin.com/project/mastodon-for-ios)
|
||
|
|
|
||
|
|
The translation will update regularly. Please request language if not listed via issue.
|
||
|
|
|
||
|
|
## Pull Request
|
||
|
|
|
||
|
|
You can make a pull request directly with small block code changes for bugfix or feature implementations. Before making a pull request with hundred lines of changes to this repository, please first discuss the change you wish to make via issue.
|
||
|
|
|
||
|
|
Also, there are lots of existing feature request issues that could be a good-first-issue discussing place.
|
||
|
|
|
||
|
|
Follow the git-flow pattern to make your pull request.
|
||
|
|
|
||
|
|
1. Ensure you are checkout on the `develop` branch.
|
||
|
|
2. Write your codes and test them on **iPad and iPhone**.
|
||
|
|
3. Merge the `develop` into your branch then make a Pull Request. Please merge the branch and resolve any conflicts when the `develop` updates. **Do not force push your codes.**
|
||
|
|
4. Make sure the permission for your folk is open to the reviewer. Code style fix, conflict resolution, and other changes may be committed by the reviewer directly.
|
||
|
|
5. Request a code review and wait for approval. The PR will be merged when it is approved.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
The documents for this app is list under the [Documentation](../Documentation/) folder. We are also welcome contributions for documentation.
|