Show More
@@ -1,111 +1,108 b'' | |||
|
1 | 1 | |
|
2 | 2 | ======================= |
|
3 | 3 | Contributing Overview |
|
4 | 4 | ======================= |
|
5 | 5 | |
|
6 | 6 | |
|
7 | 7 | RhodeCode Community Edition is an open source code management platform. We |
|
8 | 8 | encourage contributions to our project from the community. This is a basic |
|
9 | 9 | overview of the procedures for adding your contribution to RhodeCode. |
|
10 | 10 | |
|
11 | 11 | |
|
12 | 12 | |
|
13 | 13 | Check the Issue Tracker |
|
14 | 14 | ======================= |
|
15 | 15 | |
|
16 | 16 | Make an account at https://issues.rhodecode.com/account/register and browse the |
|
17 | 17 | current tickets for bugs to fix and tasks to do. Have a bug or feature that you |
|
18 | 18 | can't find in the tracker? Create a new issue for it. When you select a ticket, |
|
19 | 19 | make sure to assign it to yourself and mark it "in progress" to avoid duplicated |
|
20 | 20 | work. |
|
21 | 21 | |
|
22 | 22 | |
|
23 | 23 | |
|
24 | 24 | Sign Up at code.rhodecode.com |
|
25 | 25 | ============================= |
|
26 | 26 | |
|
27 | 27 | Make an account at https://code.rhodecode.com/ using an email or your existing |
|
28 | 28 | GitHub, Bitbucket, Google, or Twitter account. Fork the repo you'd like to |
|
29 | 29 | contribute to; we suggest adding your username to the fork name. Clone your fork |
|
30 | 30 | to your computer. We use Mercurial for source control management; see |
|
31 | 31 | https://www.mercurial-scm.org/guide to get started quickly. |
|
32 | 32 | |
|
33 | 33 | |
|
34 | 34 | |
|
35 | 35 | Set Up A Local Instance |
|
36 | 36 | ======================= |
|
37 | 37 | |
|
38 | 38 | You will need to set up an instance of RhodeCode CE using VCSServer so that you |
|
39 | 39 | can see your work locally as you make changes. We recommend using Linux for this |
|
40 | 40 | but it can also be built on OSX. |
|
41 | 41 | |
|
42 | 42 | See :doc:`dev-setup` for instructions. |
|
43 | 43 | |
|
44 | 44 | |
|
45 | 45 | |
|
46 | 46 | Code! |
|
47 | 47 | ===== |
|
48 | 48 | |
|
49 | 49 | You can now make, see, and test your changes locally. We are always improving to |
|
50 | 50 | keep our code clean and the cost of maintaining it low. This applies in the same |
|
51 | 51 | way for contributions. We run automated checks on our pull requests, and expect |
|
52 | 52 | understandable code. We also aim to provide test coverage for as much of our |
|
53 | 53 | codebase as possible; any new features should be augmented with tests. |
|
54 | 54 | |
|
55 | 55 | Keep in mind that when we accept your contribution, we also take responsibility |
|
56 | 56 | for it; we must understand it to take on that responsibility. |
|
57 | 57 | |
|
58 | 58 | See :doc:`standards` for more detailed information. |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | Commit And Push Your Changes |
|
63 | 63 | ============================ |
|
64 | 64 | |
|
65 | 65 | We highly recommend making a new bookmark for each feature, bug, or set of |
|
66 | 66 | commits you make so that you can point to it when creating your pull request. |
|
67 | 67 | Please also reference the ticket number in your commit messages. Don't forget to |
|
68 | 68 | push the bookmark! |
|
69 | 69 | |
|
70 | 70 | |
|
71 | 71 | |
|
72 | 72 | Submit a Pull Request |
|
73 | 73 | ===================== |
|
74 | 74 | |
|
75 | 75 | Go to your fork, and choose "Create Pull Request" from the Options menu. Use |
|
76 | 76 | your bookmark as the source, and choose someone to review it. Don't worry about |
|
77 | 77 | chosing the right person; we'll assign the best contributor for the job. You'll |
|
78 | 78 | get feedback and an assigned status. |
|
79 | 79 | |
|
80 | 80 | Be prepared to make updates to your pull request after some feedback. |
|
81 | 81 | Collaboration is part of the process and improvements can often be made. |
|
82 | 82 | |
|
83 | 83 | |
|
84 | 84 | |
|
85 | 85 | Sign the Contributor License Agreement |
|
86 | 86 | ====================================== |
|
87 | 87 | |
|
88 | 88 | If your contribution is approved, you will need to virtually sign the license |
|
89 |
agreement in order for it to be merged into the project's codebase. |
|
|
90 | it on our website here: https://rhodecode.com/static/pdf/RhodeCode-CLA.pdf | |
|
89 | agreement in order for it to be merged into the project's codebase. | |
|
91 | 90 | |
|
92 | To sign, go to code.rhodecode.com | |
|
93 | and clone the CLA repository. Add your name and make a pull request to add it to | |
|
94 | the contributor agreement; this serves as your virtual signature. Once your | |
|
95 | signature is merged, add a link to the relevant commit to your contribution | |
|
96 | pull request. | |
|
91 | You can read it on our website at https://rhodecode.com/rhodecode-cla | |
|
92 | ||
|
93 | To sign electronically, go to https://rhodecode.com/sign-cla | |
|
97 | 94 | |
|
98 | 95 | |
|
99 | 96 | |
|
100 | 97 | That's it! We'll take it from there. Thanks for your contribution! |
|
101 | 98 | ------------------------------------------------------------------ |
|
102 | 99 | |
|
103 | 100 | .. note:: If you have any questions or comments, feel free to contact us through |
|
104 | 101 | either the community portal(community.rhodecode.com), IRC |
|
105 | 102 | (irc.freenode.net), or Slack (rhodecode.com/join). |
|
106 | 103 | |
|
107 | 104 | |
|
108 | 105 | |
|
109 | 106 | |
|
110 | 107 | |
|
111 | 108 |
General Comments 0
You need to be logged in to leave comments.
Login now