Add contributing documentation to Castellan
Adds documentation showing how to contribute to Castellan.
Change-Id: Id32f80329cd319f3c48ccc08456905a5824a695a
“Fernando
8 years ago
0 | If you would like to contribute to the development of OpenStack, | |
1 | you must follow the steps in this page: | |
0 | ============ | |
1 | Contributing | |
2 | ============ | |
2 | 3 | |
3 | http://docs.openstack.org/infra/manual/developers.html | |
4 | The best way to join the community and get involved is to talk with others | |
5 | online or at a meetup and offer contributions. Here are some of the many | |
6 | ways you can contribute to the Castellan project: | |
4 | 7 | |
5 | Once those steps have been completed, changes to OpenStack | |
6 | should be submitted for review via the Gerrit tool, following | |
7 | the workflow documented at: | |
8 | * Development and Code Reviews | |
9 | * Bug reporting/Bug fixes | |
10 | * Wiki and Documentation | |
11 | * Blueprints/Specifications | |
12 | * Testing | |
13 | * Deployment scripts | |
8 | 14 | |
9 | http://docs.openstack.org/infra/manual/developers.html#development-workflow | |
15 | Before you start contributing take a look at the `Openstack Developers Guide`_. | |
10 | 16 | |
11 | Pull requests submitted through GitHub will be ignored. | |
17 | .. _`Openstack Developers Guide`: http://docs.openstack.org/infra/manual/developers.html | |
12 | 18 | |
13 | Bugs should be filed on Launchpad, not GitHub: | |
19 | Freenode IRC (Chat) | |
20 | ------------------- | |
21 | You can find Castellaneers in our publicly accessible channel on `freenode`_ | |
22 | ``#openstack-barbican``. All conversations are logged and stored for your | |
23 | convenience at `eavesdrop.openstack.org`_. For more information regarding | |
24 | OpenStack IRC channels please visit the `OpenStack IRC Wiki`_. | |
14 | 25 | |
15 | https://bugs.launchpad.net/castellan | |
26 | .. _`freenode`: https://freenode.net | |
27 | .. _`OpenStack IRC Wiki`: https://wiki.openstack.org/wiki/IRC | |
28 | .. _`eavesdrop.openstack.org`: http://eavesdrop.openstack.org/irclogs/ | |
29 | %23openstack-barbican/ | |
30 | ||
31 | Launchpad | |
32 | --------- | |
33 | Like other OpenStack related projects, we utilize Launchpad for our bug | |
34 | and release tracking. | |
35 | ||
36 | * `Castellan Launchpad Project`_ | |
37 | ||
38 | .. _`Castellan Launchpad Project`: https://launchpad.net/castellan | |
39 | ||
40 | .. note:: | |
41 | ||
42 | Bugs should be filed on Launchpad, not Github. | |
43 | ||
44 | Source Repository | |
45 | ----------------- | |
46 | Like other OpenStack related projects, the official Git repository is | |
47 | available on `Castellan on GitHub`_. | |
48 | ||
49 | .. _`Castellan on GitHub`: https://github.com/openstack/castellan | |
50 | ||
51 | Gerrit | |
52 | ------ | |
53 | Like other OpenStack related projects, we utilize the OpenStack Gerrit | |
54 | review system for all code reviews. If you're unfamiliar with using | |
55 | the OpenStack Gerrit review system, please review the `Gerrit Workflow`_ | |
56 | wiki documentation. | |
57 | ||
58 | .. _`Gerrit Workflow`: http://docs.openstack.org/infra/manual/developers.html#development-workflow | |
59 | ||
60 | .. note:: | |
61 | ||
62 | Pull requests submitted through GitHub will be ignored. |