Skip to content

Commit

Permalink
docs(package): update contributing.md, add issue, pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
I committed Jul 26, 2016
1 parent 39acdfb commit b8704b9
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 24 deletions.
43 changes: 43 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to Graffiti-Mongoose

## Issues: got a question or problem?

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues. Providing the following information will increase the
chances of your issue being dealt with quickly:

- **Overview of the Issue**
- **Reproduce the Error**
- **Related Issues**
- **Suggest a Fix**

## Submitting a Pull Request

1. Fork the project
2. Make your changes in a new git branch:

```shell
git checkout -b fix/my-branch master
```
3. Commit your changes using a descriptive commit message that follows the [Angular commit message format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format)

```shell
git commit -a
```
4. Push your branch to GitHub:

```shell
git push origin fix/my-branch
```
5. In GitHub, send a pull request to `master`

General checklist:
- [ ] tests must pass
- [ ] follow existing coding style
- [ ] if you add a feature, add documentation to `README`
- [ ] if you fix a bug, add a test

#### Thank you for your contribution!
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Overview of the Issue

Give a short description of the issue.

```javascript
If an error was thrown, paste here the stack trace.
```

## Reproduce the Error

Provide an unambiguous set of steps, Node version, package version, etc.

Steps to reproduce:
1. step
2. step
3. step

Node version: `x.x.x`
Graffiti version: `x.x.x`

## Related Issues

Has a similar issue been reported before?

## Suggest a Fix

If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

### Thank you for your contribution!
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Before sending a pull-request please open an issue to discuss new features or non-trivial changes.

### Thank you for your contribution!
23 changes: 0 additions & 23 deletions CONTRIBUTING.md

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(The MIT License)

Copyright (c) 2015 RisingStack, Inc.
Copyright (c) 2016 RisingStack, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

0 comments on commit b8704b9

Please sign in to comment.