You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2017/05/20 20:24:41 UTC
[couchdb-documentation] branch master updated: Add/update
contribution guidelines, issue/PR templates for GH Issues
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 18c11f4 Add/update contribution guidelines, issue/PR templates for GH Issues
18c11f4 is described below
commit 18c11f4e18d18e6887f71a5fdf5c6eb79a2375fb
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Wed May 17 13:57:50 2017 -0400
Add/update contribution guidelines, issue/PR templates for GH Issues
---
.github/ISSUE_TEMPLATE.md | 32 +++++++++++++++++++++++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 41 ++++++++++++++++++++++++++++++++++++++++
README.md | 19 +++++++++++++++++++
3 files changed, 92 insertions(+)
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..75edf99
--- /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-documentation/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
+
+- [ ] Documentation is written and is accurate;
+- [ ] `make check` passes with no errors
+- [ ] Update [rebar.config.script](https://github.com/apache/couchdb/blob/master/rebar.config.script) with the commit hash once this PR is rebased and merged
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b55a64c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# CouchDB Documentation [](https://travis-ci.org/apache/couchdb-documentation)
+
+This repository contains the Sphinx source for Apache CouchDB's documentation.
+You can view the latest rendered build of this content at:
+
+ http://docs.couchdb.org/en/latest
+
+# Feedback, Issues, Contributing
+
+General feedback is welcome at our [user][1] or [developer][2] mailing lists.
+
+Apache CouchDB has a [CONTRIBUTING][3] file with details on how to get started
+with issue reporting or contributing to the upkeep of this project.
+
+[1]: http://mail-archives.apache.org/mod_mbox/couchdb-user/
+[2]: http://mail-archives.apache.org/mod_mbox/couchdb-dev/
+[3]: https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md
+
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].