Fauxton: Adding an info file for contributors
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/a3559974 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/a3559974 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/a3559974 Branch: refs/heads/2041-update-ibrowse Commit: a3559974f539ebf0ca44e849fc161c3f8fb7e3b0 Parents: d2a3c3c Author: suelockwood <[email protected]> Authored: Fri Mar 14 10:02:10 2014 -0400 Committer: suelockwood <[email protected]> Committed: Fri Mar 14 10:02:22 2014 -0400 ---------------------------------------------------------------------- src/fauxton/CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/a3559974/src/fauxton/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/src/fauxton/CONTRIBUTING.md b/src/fauxton/CONTRIBUTING.md new file mode 100644 index 0000000..3b3b623 --- /dev/null +++ b/src/fauxton/CONTRIBUTING.md @@ -0,0 +1,22 @@ +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/?filter=12326543). + +We try to keep all tickets up to date with Skill level for you to have an idea of the level of effort or comfortability with the framework you'd need to complete the task. + +To fix an issue in Fauxton, fork the Couchdb project to your github account. The [Readme file](https://github.com/apache/couchdb/blob/master/src/fauxton/readme.md) has information about how to get the project running. To start working on a specific ticket, create a branch with the Jira ID # 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, please create one. + +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** or **Deathbear**, though anyone in the room should be able to help you. + +We appreciate constructive feedback from people who use couchdb, so don't be shy. We know there are bugs and we know there is room for improvement. + +Ê´â¢á´¥â¢`Ê Thanks! + +-- 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.
