Repository: couchdb-fauxton Updated Branches: refs/heads/master 6ed784b68 -> 7f5bf886e
Write up expectations we have for contributions - mention styleguide - mention commit message format - small bugfixes do not need a Jira ticket Project: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/commit/7f5bf886 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/tree/7f5bf886 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/diff/7f5bf886 Branch: refs/heads/master Commit: 7f5bf886eaa0e1355b1607bb3b8ad535369457d0 Parents: 6ed784b Author: Robert Kowalski <[email protected]> Authored: Sun Nov 2 19:22:37 2014 +0100 Committer: Robert Kowalski <[email protected]> Committed: Tue Nov 11 11:16:01 2014 +0100 ---------------------------------------------------------------------- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++-- readme.md | 5 ++++- 2 files changed, 32 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/7f5bf886/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d5a975..fd54e38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,14 +5,40 @@ CouchDB is an Apache project, which is why we keep all our issues in Jira. You 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 project to your GitHub account. The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/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. +The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project running. + +##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. > e.g. 1234-Added-support-for-list-functions -If there is no Jira ticket for the issue you have, please create one. +If there is no Jira ticket 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: + +``` +grunt test +``` + +You can also open `couchdb-fauxton/test/runner.html` in a browser. Click on the headlines of the testcases to just run a specific test that fails - it should be faster than running the whole testsuite every time. + +Commit messages should follow the following style: + +``` +A brief one line description < 72 chars + +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) +``` 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 **Deathbear**, though anyone in the room should be able to help you. +## Get in Touch 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! http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/7f5bf886/readme.md ---------------------------------------------------------------------- diff --git a/readme.md b/readme.md index 3c6f707..b95678f 100644 --- a/readme.md +++ b/readme.md @@ -42,6 +42,9 @@ And then... You should be able to access Fauxton on `http://localhost:8000` +### Styleguide +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) + ### Prepare Fauxton Release Follow the "Fauxton Setup" section, edit settings.json variable root where the document will live, e.g. "/_utils/fauxton/" then: @@ -94,4 +97,4 @@ of items to do. npm run couchdebug # Or fully compiled install - npm run couchdb \ No newline at end of file + npm run couchdb
