You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-57Lines changed: 9 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,72 +12,23 @@ Contributions to CouchDB are governed by our [Code of Conduct][6] and a set of
12
12
[Project Bylaws][7]. Apache CouchDB itself also has a [CONTRIBUTING.md][9] if
13
13
you want to help with the larger project. Come join us!
14
14
15
-
16
15
## Contributor quick start
17
16
18
17
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)
19
18
on how to send one :)
20
19
21
-
The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project running.
22
-
23
-
Instructions to get a dev environment up and running as fast as possible:
24
-
25
-
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:
26
-
27
-
```
28
-
npm install -g pouchdb-server
29
-
pouchdb-server --port 5984
30
-
```
31
-
32
-
Now that we have a CouchDB (or PouchDB Server) up and running, check out the code:
Next, copy `settings.json.default.json` to `settings.json`. This will be our local settings file.
41
-
42
-
In the `settings.json`, under `"development"` -> `"app"`, change the `"host"` to point to your local CouchDB or PouchDB Server, e.g.:
43
-
44
-
```js
45
-
"development": {
46
-
/* ... */
47
-
"app": {
48
-
/* ... */
49
-
"host":"http://localhost:5984"
50
-
}
51
-
}
52
-
```
53
-
54
-
Now run:
55
-
56
-
npm run dev
57
-
58
-
And your Fauxton dev server will be up and running at `localhost:8000`.
59
-
20
+
The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project set up for development.
60
21
61
22
## Guide to Contributions
62
23
63
-
We follow our coding-styleguide to make it easier for everyone to write, read and review code:
24
+
We follow our coding-styleguide to make it easier for everyone to write, read and review code:
To start working on a specific ticket, create a branch with the GitHub Issue # followed by a traincase description of the issue.
67
28
68
-
> e.g. 1234-Added-support-for-list-functions
69
-
70
-
If there is no GH Issue for the issue you have, you don't have to create one.
29
+
> e.g. 1234-Added-support-for-list-functions
71
30
72
-
Please describe the issue, how it happens and how you fixed it in the commit message. Before you submit the Pull
73
-
Request, please run our testsuite and make sure that it passes:
74
-
75
-
```
76
-
grunt test
77
-
```
78
-
79
-
You can also open `couchdb-fauxton/test/runner.html` in a browser. Click on the headlines of the testcases to just run
80
-
a specific test that fails - it should be faster than running the whole testsuite every time.
31
+
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.
81
32
82
33
Commit messages should follow the following style:
83
34
@@ -92,20 +43,21 @@ Fixes #XXX (if there is a GH Issue)
92
43
Fixes apache/couchdb#XXX (if there is a CouchDB project GH Issue)
93
44
```
94
45
95
-
When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back
96
-
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].
46
+
Before you submit the Pull Request, please [run our test suite](#tests.md) and make sure that it passes.
47
+
48
+
We regularly check the PR list for Fauxton and should get back
49
+
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].
97
50
Ping **garren**, **robertkowalski** or **michellep** though anyone in the room should be able to help you.
98
51
99
52
## Get in Touch
100
53
101
-
We appreciate constructive feedback from people who use CouchDB, so don't be shy. We know there are bugs and we know
54
+
We appreciate constructive feedback from people who use CouchDB, so don't be shy. We know there are bugs and we know
0 commit comments