New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Documentation]Add text on contributing-how-to-contribute.md #22
Conversation
Signed-off-by: Matheus Clark dos Santos Monte <matheus.m@samsung.com>
@@ -5,3 +5,89 @@ sidebar_label: How to Contribute | |||
--- | |||
|
|||
## How to Contribute | |||
|
|||
Contribute is always welcome on our project, so if you`re interesting on contribute with us: THANKS! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
break one line here
+ Bulling | ||
+ Personal Offenses | ||
|
||
Together, we can maintain the health of our project, some responsibilities of the members: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can maintain the health of our project. Here is some...
|
||
Together, we can maintain the health of our project, some responsibilities of the members: | ||
|
||
+ To be educated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Be nice
|
||
+ To be educated | ||
+ Respond when mentioned | ||
+ Help the beginners (remember, you were a beginner). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Support the beginners.
|
||
## Coding Style | ||
|
||
Our project contains a lint, please, check this before procced with your PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe it's worth to mention Prettier here.
|
||
## Documentation | ||
|
||
If you have some doubt about the project, you can check the wiki or check the documentation on our [github](https://github.com/raphamorim/react-ape/tree/master/docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you have some question or suggestion, open an issue. Let's chat about it!
|
||
## License | ||
|
||
We are under [MIT license](https://opensource.org/licenses/MIT) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MIT License](https://github.com/raphamorim/react-ape/blob/master/README.md)
|
||
Some branchs to future features can be create, don`t use if you are not envolved on this feature development. | ||
|
||
If you have some doubt about branchs to use, please send e-mail to mainteners or open a issue with your question. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please open a issue with your question.
|
||
## Branch Organization | ||
|
||
We keep our master in good shape, with tests passing (Almost all times :) ). Always use your up-to-date |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please remove this paragraph
If you want to submit some code for our repository, please, follow this steps: | ||
|
||
+ Fork our repository | ||
+ Code in your forked repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+ Write your code
|
||
+ Fork our repository | ||
+ Code in your forked repository | ||
+ Run the lint in your final code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+ Run lint and test task
+ Run the lint in your final code | ||
+ Submit a pull request to marge or release branch (Please, check where is the best place in our roadmap). | ||
+ Wait for review, if you PR "need changes", change and commit at the same PR | ||
+ If everything is ok, you PR will be accept by our team. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+ Done!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Good job so far. Just left notes 👍
Signed-off-by: Matheus Monte <clark.monte1@gmail.com>
@raphamorim I apply your changes :) |
@@ -5,3 +5,89 @@ sidebar_label: How to Contribute | |||
--- | |||
|
|||
## How to Contribute | |||
|
|||
Contribute is always welcome on our project, | |||
so if you`re interesting on contribute with us: THANKS! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you're
Aiming at a healthy community and with an active voice of all its members, it will not be allowed: | ||
|
||
+ Discrimination for any reason | ||
+ Use of slang words |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this line please
Signed-off-by: Matheus Monte <clark.monte1@gmail.com>
Done, please, check :) |
|
||
## Our development Process | ||
|
||
This repository is managed by Raphael Amorim, as maintener and creator of React-Ape, he( or another person indicate by him) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can remove this paragraph
Signed-off-by: Matheus Monte <clark.monte1@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Matheus Clark dos Santos Monte matheus.m@samsung.com