diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..be4f81685 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,32 @@ + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. +2. +3. +4. + +## Context + + + +## Your Environment + +* 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 000000000..cd39026f4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ + + +## Overview + + + +## Testing recommendations + + + +## GitHub issue number + + + +## Related Pull Requests + + + +## Checklist + +- [ ] Code is written and works correctly; +- [ ] Changes are covered by tests; +- [ ] Documentation reflects the changes; +- [ ] Update [rebar.config.script](https://github.com/apache/couchdb/blob/master/rebar.config.script) with the correct tag once a new Fauxton release is made diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d35579c0..6a201a3b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,25 @@ # Contributing to Fauxton -CouchDB is an Apache project, which is why we keep all our issues in Jira. You can find or submit issues for Fauxton -[here](https://issues.apache.org/jira/issues/?jql=project%20%3D%20COUCHDB%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20Fauxton%20ORDER%20BY%20priority%20DESC). +Please take a moment to review this document in order to make the contribution +process easy and effective for everyone involved. -We try to keep all tickets up to date with Skill level for you to have an idea of the level of effort or comfort -with the framework you'd need to complete the task. +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! -The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project running. ## Contributor quick start +If you never created a pull request before, welcome :tada: :smile: [Here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) +on how to send one :) + +The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project running. + Instructions to get a dev environment up and running as fast as possible: First, ensure that you have Node and npm installed. You should also have either CouchDB 2.0+ or PouchDB Server. The easiest to install is PouchDB Server: @@ -47,16 +57,17 @@ Now run: And your Fauxton dev server will be up and running at `localhost:8000`. + ## Guide to Contributions We follow our coding-styleguide to make it easier for everyone to write, read and review code: [https://github.com/apache/couchdb-fauxton/blob/master/styleguide.md](https://github.com/apache/couchdb-fauxton/blob/master/styleguide.md) -To start working on a specific ticket, create a branch with the Jira ID # followed by a traincase description of the issue. +To start working on a specific ticket, create a branch with the GitHub Issue # followed by a traincase description of the issue. > e.g. 1234-Added-support-for-list-functions -If there is no Jira ticket for the issue you have, you don't have to create one. +If there is no GH Issue for the issue you have, you don't have to create one. Please describe the issue, how it happens and how you fixed it in the commit message. Before you submit the Pull Request, please run our testsuite and make sure that it passes: @@ -77,12 +88,13 @@ Followed by further explanation if needed, this should be wrapped at around 72 characters. Most commits should reference an existing issue -Closes COUCHDB-XXXX (if there is a Jira ticket) +Fixes #XXX (if there is a GH Issue) +Fixes apache/couchdb#XXX (if there is a CouchDB project GH Issue) ``` When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back -to you with a code review. If no one has responded to you yet, you can find us on IRC in #couchdb-dev. -Ping **Garren**, **robertkowalski** or **michellep** though anyone in the room should be able to help you. +to you with a code review. If no one has responded to you yet, you can find us on [Freenode IRC in #couchdb-dev][8]. +Ping **garren**, **robertkowalski** or **michellep** though anyone in the room should be able to help you. ## Get in Touch @@ -93,4 +105,8 @@ there is room for improvement. -- Fauxton team -PS - If you are new to contributing to open source, or using GitHub reach out to us on irc (#couchdb-dev)! We will happily help you. + +[6]: http://couchdb.apache.org/conduct.html +[7]: http://couchdb.apache.org/bylaws.html +[8]: http://webchat.freenode.net?channels=%23couchdb-dev +[9]: https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md