Skip to content

Commit 35d5fcd

Browse files
authored
CONTRIBUTING.md
add CONTRIBUTING.md
1 parent b88dd20 commit 35d5fcd

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to the teller
2+
3+
Teller is open source and we love to receive contributions from our community — you!
4+
5+
There are many ways to contribute,
6+
from writing tutorials or blog posts,
7+
improving the documentation,
8+
submitting bug reports and feature requests or writing code.
9+
10+
You can get in touch with us through [slack](https://join.slack.com/share/enQtMjczNjY5ODQ5NDM3NC1mZWI4ZDI2Zjc3MzQwOGE4MTAwM2Y3MzMyMWFjOWM3NGNjYmQ3NTY3NzM3MmUxYzQ3NjJlOGIxZjNiYzA0OGVj),
11+
feedback and ideas are always welcome.
12+
13+
## Code contributions
14+
15+
If you have a bugfix or new feature that you would like to contribute,
16+
please find or open an issue about it first.
17+
Talk about what you would like to do.
18+
It may be that somebody is already working on it,
19+
or that there are particular issues that you should know about before implementing the change.
20+
21+
### Submitting your changes
22+
23+
Generally, we require that you test any code you are adding or modifying.
24+
Once your changes are ready , submit for review and we will make sure will review it , your effort is much appreciated!
25+
26+
27+
### Workflow
28+
29+
All feature development and most bug fixes hit the master branch first.
30+
Pull requests should be reviewed by someone with commit access.
31+
Once approved, the author of the pull request,
32+
or reviewer if the author does not have commit access,
33+
should "Squash and merge".
34+

0 commit comments

Comments
 (0)