Skip to content

Commit

Permalink
Add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
ajatprabha committed Jul 1, 2019
1 parent f77d50f commit f33e9a2
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Darkroom - Contributing

Darkroom `***REMOVED***/darkroom/core` is an open-source project.
It is licensed using the [MIT License][1].
We appreciate pull requests; here are our guidelines:

1. [File an issue][2]
(if there isn't one already). If your patch
is going to be large it might be a good idea to get the
discussion started early. We are happy to discuss it in a
new issue beforehand, and you can always email
<foss+tech@go-jek.com> about future work.

2. Please use [Effective Go Community Guidelines][3].

3. We ask that you squash all the commits together before
pushing and that your commit message references the bug.

## Issue Reporting
- Check that the issue has not already been reported.
- Be clear, concise and precise in your description of the problem.
- Open an issue with a descriptive title and a summary in grammatically correct,
complete sentences.
- Include any relevant code to the issue summary.

## Pull Requests
- Please read this [how to GitHub][4] blog post.
- Use a topic branch to easily amend a pull request later, if necessary.
- Write [good commit messages][5].
- Use the same coding conventions as the rest of the project.
- Open a [pull request][6] that relates to *only* one subject with a clear title
and description in grammatically correct, complete sentences.

Much Thanks! ❤❤❤

GO-JEK Tech

[1]: https://opensource.org/licenses/MIT
[2]: https://github.com/gojektech/heimdall/issues
[3]: https://golang.org/doc/effective_go.html
[4]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[5]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[6]: https://help.github.com/articles/using-pull-requests

0 comments on commit f33e9a2

Please sign in to comment.