Show More
@@ -94,14 +94,48 b' are::' | |||||
94 | printed immediately) |
|
94 | printed immediately) | |
95 |
|
95 | |||
96 |
|
96 | |||
97 |
Co |
|
97 | Contribution guidelines | |
98 |
----------------------- |
|
98 | ----------------------- | |
99 |
|
99 | |||
100 | Kallithea is GPLv3 and we assume all contributions are made by the |
|
100 | Kallithea is GPLv3 and we assume all contributions are made by the | |
101 | committer/contributor and under GPLv3 unless explicitly stated. We do care a |
|
101 | committer/contributor and under GPLv3 unless explicitly stated. We do care a | |
102 | lot about preservation of copyright and license information for existing code |
|
102 | lot about preservation of copyright and license information for existing code | |
103 | that is brought into the project. |
|
103 | that is brought into the project. | |
104 |
|
104 | |||
|
105 | Contributions will be accepted in most formats -- such as pull requests on | |||
|
106 | Bitbucket, something hosted on your own Kallithea instance, or patches sent by | |||
|
107 | email to the `kallithea-general`_ mailing list. | |||
|
108 | ||||
|
109 | When contributing via Bitbucket, please make your fork of | |||
|
110 | https://bitbucket.org/conservancy/kallithea/ `non-publishing`_ -- it is one of | |||
|
111 | the settings on "Repository details" page. This ensures your commits are in | |||
|
112 | "draft" phase and makes it easier for you to address feedback and for project | |||
|
113 | maintainers to integrate your changes. | |||
|
114 | ||||
|
115 | .. _non-publishing: https://www.mercurial-scm.org/wiki/Phases#Publishing_Repository | |||
|
116 | ||||
|
117 | Make sure to test your changes both manually and with the automatic tests | |||
|
118 | before posting. | |||
|
119 | ||||
|
120 | We care about quality and review and keeping a clean repository history. We | |||
|
121 | might give feedback that requests polishing contributions until they are | |||
|
122 | "perfect". We might also rebase and collapse and make minor adjustments to your | |||
|
123 | changes when we apply them. | |||
|
124 | ||||
|
125 | We try to make sure we have consensus on the direction the project is taking. | |||
|
126 | Everything non-sensitive should be discussed in public -- preferably on the | |||
|
127 | mailing list. We aim at having all non-trivial changes reviewed by at least | |||
|
128 | one other core developer before pushing. Obvious non-controversial changes will | |||
|
129 | be handled more casually. | |||
|
130 | ||||
|
131 | For now we just have one official branch ("default") and will keep it so stable | |||
|
132 | that it can be (and is) used in production. Experimental changes should live | |||
|
133 | elsewhere (for example in a pull request) until they are ready. | |||
|
134 | ||||
|
135 | ||||
|
136 | Coding guidelines | |||
|
137 | ----------------- | |||
|
138 | ||||
105 | We don't have a formal coding/formatting standard. We are currently using a mix |
|
139 | We don't have a formal coding/formatting standard. We are currently using a mix | |
106 | of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and |
|
140 | of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and | |
107 | consistency with existing code. Run ``scripts/run-all-cleanup`` before |
|
141 | consistency with existing code. Run ``scripts/run-all-cleanup`` before | |
@@ -134,36 +168,6 b' page titles, button labels, headers, and' | |||||
134 |
|
168 | |||
135 | .. _English title case: https://en.wikipedia.org/wiki/Capitalization#Title_case |
|
169 | .. _English title case: https://en.wikipedia.org/wiki/Capitalization#Title_case | |
136 |
|
170 | |||
137 | Contributions will be accepted in most formats -- such as pull requests on |
|
|||
138 | Bitbucket, something hosted on your own Kallithea instance, or patches sent by |
|
|||
139 | email to the `kallithea-general`_ mailing list. |
|
|||
140 |
|
||||
141 | When contributing via Bitbucket, please make your fork of |
|
|||
142 | https://bitbucket.org/conservancy/kallithea/ `non-publishing`_ -- it is one of |
|
|||
143 | the settings on "Repository details" page. This ensures your commits are in |
|
|||
144 | "draft" phase and makes it easier for you to address feedback and for project |
|
|||
145 | maintainers to integrate your changes. |
|
|||
146 |
|
||||
147 | .. _non-publishing: https://www.mercurial-scm.org/wiki/Phases#Publishing_Repository |
|
|||
148 |
|
||||
149 | Make sure to test your changes both manually and with the automatic tests |
|
|||
150 | before posting. |
|
|||
151 |
|
||||
152 | We care about quality and review and keeping a clean repository history. We |
|
|||
153 | might give feedback that requests polishing contributions until they are |
|
|||
154 | "perfect". We might also rebase and collapse and make minor adjustments to your |
|
|||
155 | changes when we apply them. |
|
|||
156 |
|
||||
157 | We try to make sure we have consensus on the direction the project is taking. |
|
|||
158 | Everything non-sensitive should be discussed in public -- preferably on the |
|
|||
159 | mailing list. We aim at having all non-trivial changes reviewed by at least |
|
|||
160 | one other core developer before pushing. Obvious non-controversial changes will |
|
|||
161 | be handled more casually. |
|
|||
162 |
|
||||
163 | For now we just have one official branch ("default") and will keep it so stable |
|
|||
164 | that it can be (and is) used in production. Experimental changes should live |
|
|||
165 | elsewhere (for example in a pull request) until they are ready. |
|
|||
166 |
|
||||
167 |
|
171 | |||
168 | "Roadmap" |
|
172 | "Roadmap" | |
169 | --------- |
|
173 | --------- |
General Comments 0
You need to be logged in to leave comments.
Login now