Commit e32f58bd authored by Rafael Kellermann Streit's avatar Rafael Kellermann Streit Committed by GitHub

Merge pull request #503 from filipedelimabrito/contributing

[DOCS] Update CONTRIBUTING.md
parents a2acf159 fedd2a72
# Contributing to Rocket.Chat
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
The following is a set of guidelines for contributing to Rocket.Chat and its packages, which are hosted in the [Rocket.Chat Organization](https://github.com/RocketChat) on GitHub.
__Note:__ If there's a feature you'd like, there's a bug you'd like to fix, or you'd just like to get involved please raise an issue and start a conversation. We'll help as much as we can so you can get contributing - although we may not always be able to respond right away :)
## Coding standards
We are following / moving to [Google Java Style](https://google.github.io/styleguide/javaguide.html). There's a nice IntelliJ style file for the project in `config/quality/style-guide` for code formatting. (Note: We'll be hosting the style guide file until it's updated in the official repo)
We are evaluating the Google's IntelliJ (and therefore Android Studio) [plugin](https://plugins.jetbrains.com/plugin/8527) for code formatting.
We acknowledge all the code does not meet these standards but we are working to change this over time.
### Syntax check
Before submitting a PR you should get no errors on `checkstyle`.
Just run:
```
./gradlew checkstyle
```
# Contributing Guidelines - Rocket.Chat.Android
Great to have you here! Here are a few ways you can help make this project better!
## Reporting an Issue
[Github Issues](https://github.com/RocketChat/Rocket.Chat.Android/issues) are used to track todos, bugs, feature requests, and more.
## Setting up a development environment
In case you're interested in playing around with the code or giving something back, here are some instructions on how to set up your project:
### Pre-requisites
1. [Android Studio and SDK Tools](https://developer.android.com/studio/index.html).
2. Clone this repo:
```
git clone https://github.com/RocketChat/Rocket.Chat.Android
```
3. Build the project.
### Code style guide
Before submitting a PR you should follow our [Coding Style](https://github.com/filipedelimabrito/Rocket.Chat.Android/blob/develop/CODING_STYLE.md).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment