Mastodon
/
mastodon-app-ufficiale-iphone-ios
mirror of https://github.com/mastodon/mastodon-ios.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #513 from maxsz/patch-1 

Improve CONTRIBUTING.md
This commit is contained in:
CMK 2022-11-07 20:29:16 +08:00 committed by GitHub
parent 95481f1d6d 20b54df37c
commit 8b05ccc34c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/CONTRIBUTING.md
View File

@ -1,30 +1,30 @@
# Contributing # Contributing
- File the issue for bug report and feature request - File an issue to report a bug or feature request
- Translate the project in our [Crowdin](https://crowdin.com/project/mastodon-for-ios) project - Translate the project in our [Crowdin](https://crowdin.com/project/mastodon-for-ios) project
- Make the Pull Request to contribute - Make the Pull Request to contribute
## Bug Report ## Bug Report
File the issue about the bug. Make sure you are installing the latest version app from TestFlight or App Store. File an issue about the bug or feature request. Make sure you are installing the latest version of the app from TestFlight or App Store.
## Translation ## Translation
[![Crowdin](https://badges.crowdin.net/mastodon-for-ios/localized.svg)](https://crowdin.com/project/mastodon-for-ios) [![Crowdin](https://badges.crowdin.net/mastodon-for-ios/localized.svg)](https://crowdin.com/project/mastodon-for-ios)
The translation will update regularly. Please request language if not listed via issue. The translation will update regularly. Please request the language if it is not listed via an issue.
## Pull Request ## 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. You can create 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 an issue.
Also, there are lots of existing feature request issues that could be a good-first-issue discussing place. 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. Follow the git-flow pattern to make your pull request.
1. Ensure you are checkout on the `develop` branch. 1. Ensure you have started a new branch based on the `develop` branch.
2. Write your codes and test them on **iPad and iPhone**. 2. Write your changes 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.** 3. Merge the `develop` branch into your branch then make a Pull Request. Please merge the branch and resolve any conflicts if `develop` updates. **Do not force push your commits.**
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. 4. Make sure the permission for your fork 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. 5. Request a code review and wait for approval. The PR will be merged when it is approved.
## Documentation ## Documentation
The documents for this app is list under the [Documentation](../Documentation/) folder. We are also welcome contributions for documentation. The documentation for this app is listed under the [Documentation](../Documentation/) folder. We are also welcoming contributions for documentation.