Skip to content

Commit 18c11f4

Browse files
committed
Add/update contribution guidelines, issue/PR templates for GH Issues
1 parent 3b4e1ba commit 18c11f4

File tree

3 files changed

+92
-0
lines changed

3 files changed

+92
-0
lines changed

.github/ISSUE_TEMPLATE.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
6+
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
14+
15+
## Steps to Reproduce (for bugs)
16+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
18+
1.
19+
2.
20+
3.
21+
4.
22+
23+
## Context
24+
<!--- How has this issue affected you? What are you trying to accomplish? -->
25+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
26+
27+
## Your Environment
28+
<!--- Include as many relevant details about the environment you experienced the bug in -->
29+
* Version used:
30+
* Browser Name and version:
31+
* Operating System and version (desktop or mobile):
32+
* Link to your project:

.github/PULL_REQUEST_TEMPLATE.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- Thank you for your contribution!
2+
3+
Please file this form by replacing the Markdown comments
4+
with your text. If a section needs no action - remove it.
5+
6+
Also remember, that CouchDB uses the Review-Then-Commit (RTC) model
7+
of code collaboration. Positive feedback is represented +1 from committers
8+
and negative is a -1. The -1 also means veto, and needs to be addressed
9+
to proceed. Once there are no objections, the PR can be merged by a
10+
CouchDB committer.
11+
12+
See: http://couchdb.apache.org/bylaws.html#decisions for more info. -->
13+
14+
## Overview
15+
16+
<!-- Please give a short brief for the pull request,
17+
what problem it solves or how it makes things better. -->
18+
19+
## Testing recommendations
20+
21+
<!-- Describe how we can test your changes.
22+
Does it provides any behaviour that the end users
23+
could notice? -->
24+
25+
## GitHub issue number
26+
27+
<!-- If this is a significant change, please file a separate issue at:
28+
https://github.com/apache/couchdb-documentation/issues
29+
and include the number here and in commit message(s) using
30+
syntax like "Fixes #472" or "Fixes apache/couchdb#472". -->
31+
32+
## Related Pull Requests
33+
34+
<!-- If your changes affects multiple components in different
35+
repositories please put links to those pull requests here. -->
36+
37+
## Checklist
38+
39+
- [ ] Documentation is written and is accurate;
40+
- [ ] `make check` passes with no errors
41+
- [ ] 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

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CouchDB Documentation [![Build
2+
Status](https://travis-ci.org/apache/couchdb-documentation.svg?branch=master)](https://travis-ci.org/apache/couchdb-documentation)
3+
4+
This repository contains the Sphinx source for Apache CouchDB's documentation.
5+
You can view the latest rendered build of this content at:
6+
7+
http://docs.couchdb.org/en/latest
8+
9+
# Feedback, Issues, Contributing
10+
11+
General feedback is welcome at our [user][1] or [developer][2] mailing lists.
12+
13+
Apache CouchDB has a [CONTRIBUTING][3] file with details on how to get started
14+
with issue reporting or contributing to the upkeep of this project.
15+
16+
[1]: http://mail-archives.apache.org/mod_mbox/couchdb-user/
17+
[2]: http://mail-archives.apache.org/mod_mbox/couchdb-dev/
18+
[3]: https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md
19+

0 commit comments

Comments
 (0)