You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ga...@apache.org on 2017/05/18 13:45:35 UTC
[couchdb-nano] branch master updated: Add/update contribution
guidelines, issue/PR templates for GH Issues (#44)
This is an automated email from the ASF dual-hosted git repository.
garren pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-nano.git
The following commit(s) were added to refs/heads/master by this push:
new 5c38c6a Add/update contribution guidelines, issue/PR templates for GH Issues (#44)
5c38c6a is described below
commit 5c38c6a72918d89a42f9800f2435ae35246a6b23
Author: Joan Touzet <wo...@users.noreply.github.com>
AuthorDate: Thu May 18 09:45:33 2017 -0400
Add/update contribution guidelines, issue/PR templates for GH Issues (#44)
---
.github/ISSUE_TEMPLATE.md | 32 +++++++++++++++++++++++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 41 ++++++++++++++++++++++++++++++++++++++++
CONTRIBUTING.md | 24 ++++++++++++++++++-----
DCO.md | 25 ------------------------
README.md | 22 ++++++++++-----------
5 files changed, 102 insertions(+), 42 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..be4f816
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,32 @@
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Browser Name and version:
+* Operating System and version (desktop or mobile):
+* Link to your project:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..73d758e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,41 @@
+<!-- Thank you for your contribution!
+
+ Please file this form by replacing the Markdown comments
+ with your text. If a section needs no action - remove it.
+
+ Also remember, that CouchDB uses the Review-Then-Commit (RTC) model
+ of code collaboration. Positive feedback is represented +1 from committers
+ and negative is a -1. The -1 also means veto, and needs to be addressed
+ to proceed. Once there are no objections, the PR can be merged by a
+ CouchDB committer.
+
+ See: http://couchdb.apache.org/bylaws.html#decisions for more info. -->
+
+## Overview
+
+<!-- Please give a short brief for the pull request,
+ what problem it solves or how it makes things better. -->
+
+## Testing recommendations
+
+<!-- Describe how we can test your changes.
+ Does it provides any behaviour that the end users
+ could notice? -->
+
+## GitHub issue number
+
+<!-- If this is a significant change, please file a separate issue at:
+ https://github.com/apache/couchdb-nano/issues
+ and include the number here and in commit message(s) using
+ syntax like "Fixes #472" or "Fixes apache/couchdb#472". -->
+
+## Related Pull Requests
+
+<!-- If your changes affects multiple components in different
+ repositories please put links to those pull requests here. -->
+
+## Checklist
+
+- [ ] Code is written and works correctly;
+- [ ] Changes are covered by tests;
+- [ ] Documentation reflects the changes;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1ce06ca..5aa53e1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,10 +1,20 @@
-# DCO
+# Contributing to nano
-To contribute to this project you must accept our [developer certificate of origin](https://github.com/dscape/nano/blob/master/README.md)
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue, assessing
+changes, and helping you finalize your pull requests.
+
+Contributions to CouchDB are governed by our [Code of Conduct][6] and a set of
+[Project Bylaws][7]. Apache CouchDB itself also has a [CONTRIBUTING.md][9] if
+you want to help with the larger project. Come join us!
# Contributing
-Everyone is welcome to contribute with patches, bug-fixes and new features
+Everyone is welcome to contribute with patches, bug-fixes and new features.
1. Create an [issue][2] on github so the community can comment on your idea
2. Fork `nano` in github
@@ -15,7 +25,7 @@ Everyone is welcome to contribute with patches, bug-fixes and new features
7. Push to your branch `git push origin my_branch`
8. Create a pull request
-to run tests make sure you npm test but also run tests without mocks:
+To run tests, make sure you run `npm test` but also run tests without mocks:
``` sh
npm run unmocked
@@ -39,4 +49,8 @@ DEBUG=* node your_nano_scripts.js
You can turn nocks on and off using the `NOCK_OFF` environment variable.
-[2]: http://github.com/dscape/nano/issues
+[2]: http://github.com/apache/couchdb-nano/issues
+[6]: http://couchdb.apache.org/conduct.html
+[7]: http://couchdb.apache.org/bylaws.html
+[9]: https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md
+
diff --git a/DCO.md b/DCO.md
deleted file mode 100644
index 7ea005c..0000000
--- a/DCO.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
- have the right to submit it under the open source license
- indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the best
- of my knowledge, is covered under an appropriate open source
- license and I have the right under that license to submit that
- work with modifications, whether created in whole or in part
- by me, under the same open source license (unless I am
- permitted to submit under a different license), as indicated
- in the file; or
-
-(c) The contribution was provided directly to me by some other
- person who certified (a), (b) or (c) and I have not modified
- it.
-
-(d) I understand and agree that this project and the contribution
- are public and that a record of the contribution (including all
- personal information I submit with it, including my sign-off) is
- maintained indefinitely and may be redistributed consistent with
- this project or the open source license(s) involved.
diff --git a/README.md b/README.md
index dde6d77..a1f4212 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[](http://yld.io/contact?source=github-nano)[](https://gitter.im/dscape/nano)[](https://travis-ci.org/dscape/nano)[](https://travis-ci.org/apache/couchdb-nano)[](https://david-dm.org/apache/couchdb-nano)[](https://www.npmjs.com/package/nano)
# nano
@@ -963,19 +963,17 @@ where `list_doc_params` is the test name.
__/ /
/__.|_|-|_| cannes est superb
-* code: `git clone git://github.com/dscape/nano.git`
-* home: <http://github.com/dscape/nano>
-* bugs: <http://github.com/dscape/nano/issues>
-* build: [](http://travis-ci.org/dscape/nano)
-* deps: [](https://david-dm.org/dscape/nano)
-* chat: <https://gitter.im/dscape/nano>
-
-`(oo)--',-` in [caos][3]
+* code: `git clone git://github.com/apache/couchdb-nano.git`
+* home: <http://github.com/apache/couchdb-nano>
+* bugs: <http://github.com/apache/couchdb-nano/issues>
+* build: [](https://travis-ci.org/apache/couchdb-nano)
+* deps: [](https://david-dm.org/apache/couchdb-nano)
+* chat: [Freenode IRC @ #couchdb-dev][8]
[1]: http://npmjs.org
-[2]: http://github.com/dscape/nano/issues
-[3]: http://caos.di.uminho.pt/
-[4]: https://github.com/dscape/nano/blob/master/cfg/couch.example.js
+[2]: http://github.com/apache/couchdb-nano/issues
+[4]: https://github.com/apache/couchdb-nano/blob/master/cfg/couch.example.js
+[8]: http://webchat.freenode.net?channels=%23couchdb-dev
[follow]: https://github.com/jhs/follow
[request]: https://github.com/request/request
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].