Skip to content

Commit

Permalink
contributing: Init
Browse files Browse the repository at this point in the history
Co-authored-by: Amrita Goswami <[email protected]>
  • Loading branch information
HaoZeke and amritagos committed Sep 19, 2019
1 parent ed83a46 commit 8f1b280
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contributing

We love pull requests from everyone. By participating in this project, you
agree to abide by the contributor coventant suggested [code of conduct].

[code of conduct]: https://github.com/d-SEAMS/seams-core/blob/master/CODE_OF_CONDUCT.md

Do make sure to run tests and generally **BE PREPARED** to have your code vetted and
checked. Do **NOT** submit code you would not be prepared to defend or maintain,
unless you are fixing a bug.

Push to your fork and [submit a pull request][pr].

[pr]: https://github.com/d-SEAMS/seams-core/compare

At this point you're waiting on us. We like to at least comment on pull requests
within four business days (and, typically, three business day). We may suggest
some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

- Write tests.
- Follow the commit-style below.

## Commit Style

A sample **good commit** is:

```
fileName: Thing I did
Some subHeading things
So this change was to do that thing I thought was good. Also there was this
other person who thought so too, so then I ate a sandwich and we got the code
done. I am writing this but really, honestly, two people did this.
Co-authored-by: Joel Doe <[email protected]>
```

As is evident, the commit should clearly have:

- The name of the file, or the topic or the subject you have changed or the
namespace or the functionality you have added **something:**
- A line describing **something:**
- An _(optional)_ subheading with more details
- An _(optional)_ paragraph or essay on why the change was done and anything else you want to share with the devs.
- **Co-authorship** IS MANDATORY if applicable. Even if you just had a sandwich with the other person. It won't kill you to share, or to write that.

<!-- * Follow our [style guide][style]. -->

<!-- [style]: https://github.com/thoughtbot/guides/tree/master/style -->

0 comments on commit 8f1b280

Please sign in to comment.