|
1 |
| -# Contributing to WPMediaPicker |
| 1 | +# How to Contribute |
2 | 2 |
|
3 |
| -Hi! Thank you for your interest in contributing to the app, we really appreciate it. |
| 3 | +First off, thank you for contributing! We're excited to collaborate with you! 🎉 |
4 | 4 |
|
5 |
| -There are many ways to contribute – reporting bugs, feature suggestions, fixing bugs, submitting pull requests for enhancements. |
| 5 | +The following is a set of guidelines for the many ways you can join our collective effort. |
6 | 6 |
|
7 |
| -## Reporting Bugs, Asking Questions, Sending Suggestions |
| 7 | +Before anything else, please take a moment to read our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all participants, from full-timers to occasional tinkerers, to uphold it. |
8 | 8 |
|
9 |
| -Just [file a GitHub issue](https://github.com/wordpress-mobile/MediaPicker-iOS/issues), that’s all. If you want to prefix the title with a “Question:”, “Bug:”, "Feature Request:", or the general area of the application, that would be helpful, but by no means mandatory. If you have write access, add the appropriate labels. |
| 9 | +## Reporting Bugs, Asking Questions, and Suggesting Features |
10 | 10 |
|
11 |
| -If you’re filing a bug, specific steps to reproduce are helpful. Please include the part of the app that has the bug, along with what you expected to see and what happened instead. A screenshot is always helpful as well. |
| 11 | +Have a suggestion or feedback? Please go to [Issues](https://github.com/wordpress-mobile/MediaPicker-iOS/issues) and [open a new issue](https://github.com/wordpress-mobile/MediaPicker-iOS/issues/new). Prefix the title with a category like _"Bug:"_, _"Question:"_, or _"Feature Request:"_. Screenshots help us resolve issues and answer questions faster, so thanks for including some if you can. |
12 | 12 |
|
13 |
| -## Submitting code changes |
| 13 | +## Submitting Code Changes |
14 | 14 |
|
15 |
| -We welcome Pull Requests for bug fixes on any open issues that you'd like to contribute! More details on our process can be found in the [Make WordPress Mobile handbook](https://make.wordpress.org/mobile/handbook/pathways/ios/), specifically [here](https://make.wordpress.org/mobile/handbook/pathways/ios/how-to-contribute/). |
| 15 | +If you're just getting started and want to familiarize yourself with the app’s code, we suggest looking at [these issues](https://github.com/wordpress-mobile/MediaPicker-iOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) with the **good first issue** label. But if you’d like to tackle something different, you're more than welcome to visit the [Issues](https://github.com/wordpress-mobile/MediaPicker-iOS/issues) page and pick an item that interests you. |
16 | 16 |
|
17 |
| -## Discussion |
| 17 | +We always try to avoid duplicating efforts, so if you decide to work on an issue, leave a comment to state your intent. If you choose to focus on a new feature or the change you’re proposing is significant, we recommend waiting for a response before proceeding. The issue may no longer align with project goals. |
18 | 18 |
|
19 |
| -Aside from writing issues and pull requests, you can also hang out in the #mobile WordPress.org Slack channel with other WordPress Mobile developers/contributors. Check out chat.wordpress.org for instructions on how to create an account in Slack. |
| 19 | +If the change is trivial, feel free to send a pull request without notifying us. |
20 | 20 |
|
21 |
| -The purpose of the Slack chat is to provide updates about ongoing initiatives regarding the mobile apps and to discuss, prioritize and coordinate future changes. If you have questions, Slack chat is a great place to start. |
| 21 | +### Pull Requests and Code Reviews |
22 | 22 |
|
23 |
| -## Contribute to translations |
| 23 | +All code contributions pass through pull requests. If you haven't created a pull request before, we recommend this free video series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). |
24 | 24 |
|
25 |
| -We use a tool called GlotPress to manage translations. The WordPress-iOS GlotPress instance lives [here](http://translate.wordpress.org/projects/apps/ios/dev). To add new translations or fix existing ones, create an account over at GlotPress and submit your changes over at the GlotPress site. |
| 25 | +The core team monitors and reviews all pull requests. Depending on the changes, we will either approve them or close them with an explanation. We might also work with you to improve a pull request before approval. |
| 26 | + |
| 27 | +We do our best to respond quickly to all pull requests. If you don't get a response from us after a week, feel free to reach out to us via Slack. |
| 28 | + |
| 29 | +## Getting in Touch |
| 30 | + |
| 31 | +If you have questions or just want to say hi, join the [WordPress Slack](https://make.wordpress.org/chat/) and drop a message on the `#mobile` channel. |
0 commit comments