Skip to content
This repository has been archived by the owner on Nov 29, 2020. It is now read-only.

Commit

Permalink
Create CONTRIBUTING.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
aniri authored Jan 23, 2019
1 parent cf68af4 commit 428085b
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Monitorizare Vot - Android app - Contributing guide

:two_hearts: First off all, thank you for your interest in the project and for taking the time to contribute!

This project is built by amazing volunteers, just like you, from different timezones, backgrounds and skills levels. So to make sure we're all on the same page, it would be great if we all followed a few guidelines. :two_hearts:

[Feedback](#feedback) | [How Can I Contribute?](#how-can-i-contribute) | [Best practices](#best-practices) | [About Code4Ro](#about-code4ro) | [Financial contributions](#financial-contributions) | [Code of conduct](#code-of-conduct)

## Feedback

Just have a quick question? Please e-mail us at at [email protected]

## How can I contribute

### Report bugs

:bug: Think you found a bug? Please check [the list of open issues](https://github.com/code4romania/monitorizare-vot-android/issues) to see if your bug has already been reported. If it hasn't please [submit a new issue](https://github.com/code4romania/monitorizare-vot-android/issues/new).

:shield: If you find a **security vulnerability**, do not open an issue. Please email [email protected] instead.

Please be as specific as possible when describing the issue. Explain the problem and include additional details to help maintainers reproduce the problem:

* **Description**
* **Steps to Reproduce**
* Expected behavior
* Actual behavior
* Reproduces how often

### Suggest new features

:bulb: Feature requests are welcome. We would love to hear your thoughts on how we can improve our project further.

To send us a suggestion, just [open an issue](https://github.com/code4romania/monitorizare-vot-android/issues/new) which describes the feature you would like to see. Give as much information as you can about what you would like to see:

* Description
* Step by step behaviour
* Explain why this enhancement would be useful

### Contribute to the codebase

:computer: We'd love for you to get your hands dirty and code for the project.

If you are unsure where to begin contributing to the project, you can start by looking through these issues:
* [Good first issues](https://github.com/code4romania/monitorizare-vot-android/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* [Help wanted](https://github.com/code4romania/monitorizare-vot-android/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

Please make sure to check out the suggested coding [best practices](#best-practices) and tips with working with git below :wink:

## Best practices

### Coding best practices :ok_hand:

* **The language we code in is English.** Please name your variables, methods, classes and other structures using English words.
* Use clean code conventions :heavy_check_mark: *tip: read [The book](https://www.goodreads.com/book/show/3735293-clean-code) if you haven't already. Or check out [a summary](https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29)*
* Follow the [Android design guidelines](https://developer.android.com/design/) and the [Java codes style](https://source.android.com/setup/contribute/code-style) or [Kotlin styleguide](https://developer.android.com/kotlin/style-guide)
* Tests are appreciated :relieved:
* Please use relevant commit messages and reference issues in the commit message if applicable

### Git workflow

* [Fork the repo](https://github.com/code4romania/monitorizare-vot-android/fork)
* Add your contributions on the `develop` branch of your fork
* Rebase on upstream `develop` if it changed
* Create a new Pull Request, clearly mentioning what issues your pull request fixes

:wink: If you need tips on working with Git, Github or contributing to open source projects, we have gathered a list of useful guides and tutorials in our knowledge base. [Have a look](https://code4romania.github.io/knowledge/#contributing-to-open-source).

## About Code4Ro

Started in 2016, Code for Romania is a civic tech NGO, official member of the Code for All network. We have a community of over 500 volunteers (developers, ux/ui, communications, data scientists, graphic designers, devops, it security and more) who work pro-bono for developing digital solutions to solve social problems. #techforsocialgood. If you want to learn more details about our projects [visit our site](https://www.code4.ro/en/) or if you want to talk to one of our staff members, please e-mail us at [email protected].

## Financial contributions

Last, but not least, we rely on donations to ensure the infrastructure, logistics and management of our community that is widely spread across 11 timezones, coding for social change to make Romania and the world a better place. If you want to support us, [you can do it here](https://code4.ro/en/donate/).

## Code of conduct

This project and everyone participating in it is governed by the [Code for Romania Code of Conduct](https://code4.ro/en/code-of-conduct/). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

0 comments on commit 428085b

Please sign in to comment.