Skip to content

Commit 79fc4c7

Browse files
authored
Create CONTRIBUTING.md
1 parent d02a4ae commit 79fc4c7

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# How to contribute to devSTORE
2+
3+
This repo is a reference and learning resource and everyone is invited to contribute.
4+
5+
There's a general development strategy that's driven by @EduardoPires / @BrunoHBrito, who chooses, or defines criteria for choosing, the issues to include in the codebase, given a bunch of constraints and other guidelines.
6+
7+
## Coding Standards
8+
9+
There are no explicit coding standards so pay attention to the general coding style, that's (mostly) used everywhere.
10+
11+
## Development Process
12+
13+
In order to help manage community contributions and avoid conflicts, there's a [Issues Approved List](https://github.com/desenvolvedor-io/dev-store/issues) so pick one to help us.
14+
15+
That's not too easy to define and there are no clear criteria right now but, probably, changing "a couple" lines of code in one file would not qualify while changing "a bunch" of files would.
16+
17+
We'll all be learning in the process so we'll figure it out somehow.
18+
19+
### General Steps
20+
21+
1. Issues are managed as usual with the regular issues list, just like any other repo.
22+
23+
2. Community members can propose themselves to code an issue.
24+
25+
3. Issues with the **help wanted** label is the best choice for you!
26+
27+
4. Before start coding use the issue to talk with the team and propose your solution.
28+
29+
## Tests
30+
31+
There's not a tests policy in the project at this moment, but it'll be greatly appreciated if you include tests.
32+
33+
## Forks and Branches
34+
35+
All contributions must be submitted as a [Pull Request (PR)](https://help.github.com/articles/about-pull-requests/) so you need to [fork this repo](https://help.github.com/articles/fork-a-repo/) on your GitHub account.
36+
37+
## DISCLAIMER - This is not a PRODUCTION-READY TEMPLATE for microservices
38+
Since this is a learning resource, some design decisions have favored simplicity to convey a pattern, over production-grade robustness.
39+
40+
## Suggestions
41+
42+
We hope this helps us all to work better and avoid some of the problems/frustrations of working in such a large community.
43+
44+
We'd also appreciate any comments or ideas to improve this.
45+

0 commit comments

Comments
 (0)