Skip to content

Commit 018cd01

Browse files
committed
Updating README and CONTRIBUTING
Signed-off-by: TomazMartins <[email protected]>
1 parent 9b964c4 commit 018cd01

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

Diff for: CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to Contribute
2+
To contribute Akan project in its Android version, please carefully read this document and follow the instructions.
3+
4+
1. Read the code convention (style sheet) used by the Akan team and follow it strictly.
5+
2. Read our branches policy and follow it.
6+
3. Check the list of *issues* project. When selecting any *issue* you want to work, let the team, commenting on the discussion of the *issue*.
7+
4.Send your *pull request* and wait for the review.
8+
9+
=]
10+
11+
## To become a Contributor Effective Team
12+
To be inside the contributors team must have at least two *pull request* accepted and a formal request via e-mail or mailing list.
13+
14+
---
15+
# Como Contribur
16+
Para contribuir com o projeto AKAN, em sua versão Android, por gentileza, leia com atenção esse documento e siga as instruções.
17+
18+
1. Leia a convenção de código (folha de estilo) utilizada pela equipe do AKAN e siga-a rigorosamente.
19+
2. Leia a nossa política de branches e siga-a.
20+
3. Confira a lista de *issues* do projeto. Ao selecionar alguma *issue* na qual deseja trabalhar, avise à equipe, comentando na discussão da *issue*.
21+
4. Envie seu *pull request* e espere a revisão.
22+
23+
=]
24+
25+
## Para tornar-se um Contribuidor Efetivo do Time
26+
Para estar dentro do time de contribuidores deve-se ter pelo menos dois *pull request* aceitos, bem como uma solicitação formal, via e-mail ou na lista de discussões.

Diff for: README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AKANAndroid
1+
# AKANAndroid - Political Consciousness
22
This is the repository for AKAN project in its Android version, welcome to cooperate with it!
33

44
AKAN is a word originated from a Tupi (brazilian indigenous people) term, Akangatu, which means memory, intelligence.
@@ -16,7 +16,7 @@ To contribute to the project, please, first read the document below:
1616
# Authors
1717
The authors of the test project for AkanAndroid are listed in the document quoted below.
1818

19-
[Authors][authors]
19+
* [Authors][authors]
2020

2121
# License
2222
Information related to the project license is contained in the document below:
@@ -27,9 +27,11 @@ Information related to the project license is contained in the document below:
2727
To contact with the AkanAndroid team use one of the following ways:
2828

2929
30+
* Google Groups: [Akan Group][groups]
3031
* Create issues in repository, follow the guide.
3132

3233
<!-- Links -->
3334
[how_to_contribute]: https://github.com/VisualizeMobile/AKANAndroid/blob/working_tree/CONTRIBUTING.md
3435
[authors]: https://github.com/VisualizeMobile/AKANAndroid/blob/working_tree/AUTHORS.md
3536
[license]: https://github.com/VisualizeMobile/AKANAndroid/blob/working_tree/LICENSE.txt
37+
[groups]: https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!forum/app_akan

0 commit comments

Comments
 (0)