From b8704b980b21d69487df52608551f379a9965fbc Mon Sep 17 00:00:00 2001 From: I Date: Tue, 26 Jul 2016 16:25:22 +0200 Subject: [PATCH] docs(package): update contributing.md, add issue, pull request templates --- .github/CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 29 +++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 3 +++ CONTRIBUTING.md | 23 ----------------- LICENSE | 2 +- 5 files changed, 76 insertions(+), 24 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..69919e0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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! diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..05372ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -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! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b4dbfe1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index cd61f9b..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,23 +0,0 @@ -## PRs and Code contributions - -* Tests must pass. -* Follow existing coding style. -* If you fix a bug, add a test. - -## Issues - -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** - if an error is being thrown a non-minified stack trace helps -* **Motivation for or Use Case** - explain why this is a bug for you -* **Angular Version(s)** - is it a regression? -* **Browsers and Operating System** - is this a problem with all browsers or only IE8? -* **Reproduce the Error** - provide an unambiguous set of steps. -* **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) diff --git a/LICENSE b/LICENSE index d15eb07..9f81ae5 100644 --- a/LICENSE +++ b/LICENSE @@ -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