Skip to content

Commit 82033d1

Browse files
committed
docs: Clarify how to get your code accepted
1 parent 961cb71 commit 82033d1

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ If you've got an idea for Open Rails, please report it in [our road-map on Trell
1616

1717
## Writing code
1818

19+
### Choosing what to work on
20+
1921
You are free to make any modifications to the Open Rails code that you like; that's how open source works. However, we won't necessarily include all changes in the official version, so here are the ways to ensure that what you're working on will be accepted:
2022

2123
* If you'd like to work on something that is already known about and accepted, please check through [the confirmed bugs](https://bugs.launchpad.net/or/+bugs?orderby=-importance&field.status%3Alist=TRIAGED) and [accepted feature requests (anything except the first two columns)](https://trello.com/b/DS2h3Pxc/open-rails-roadmap).
@@ -75,9 +77,15 @@ For each object stored in a field or property that is accessed from multiple thr
7577

7678
If you are in any doubt about the use of data by multiple threads, or your implementation of the above rules, please ask in the [Elvas Tower](http://www.elvastower.com/) forums.
7779

78-
### Pull requests
80+
### Getting your code accepted
81+
82+
Your code should be fixing exactly one bug or adding a single new feature; mixing multiple bug fixes or new features makes it harder to review your changes and risks them not being accepted.
83+
84+
When you're done writing code, you should make a pull request on GitHub or a merge request on Launchpad. The title and description of the requests should clearly and concisely indicate what bug or feature you've implemented and you will need to include links to whichever of the following are appropriate:
7985

80-
Pull requests should contain exactly one bug fix or new feature; do not mix multiple bug fixes, multiple features, or bug fixes and features together in any way. The bug report or feature request must be linked from the pull request.
86+
* Bug report
87+
* Road-map card
88+
* Blueprint
8189

8290
## How bugs and features are accepted
8391

@@ -87,13 +95,13 @@ A member of [our developer team](https://launchpad.net/~ordevs/+members) will ma
8795

8896
### Road-map cards
8997

90-
We highly recommend that a [forum thread is created](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/) with each feature request, so that the community may discuss it and flag up any potential issues. We typically won't approve a feature request until it has had a week for discussion, and there are no unresolved objections.
98+
We highly recommend that a [forum thread is created](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/) with each feature request, so that the community may discuss it and flag up any potential issues. We typically allow at least a week for discussion and identification of any issues.
9199

92-
A member of [our management team](https://launchpad.net/~orsupervisors/+members) will read the request and follow the forum discussion being had by the community, classify it by type (using labels), and place it into an appropriate list in Trello. It the rare event that we do not agree with the feature being added to Open Rails, it will be placed in the "Not planned at this time" list and a comment added explaining why.
100+
A member of [our management team](https://launchpad.net/~orsupervisors/+members) will read the request and follow the forum discussion being had by the community, classify it by type (using labels), and place it into an appropriate list in Trello. In the rare event that we do not agree with the feature being added to Open Rails, it will be placed in the "Not planned at this time" list and a comment added explaining why.
93101

94102
### Blueprints
95103

96-
We highly recommend that a [forum thread is created](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/) with each feature request, so that the community may discuss it and flag up any potential issues. We typically won't approve a feature request until it has had a week for discussion, and there are no unresolved objections.
104+
We highly recommend that a [forum thread is created](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/) with each feature request, so that the community may discuss it and flag up any potential issues. We typically allow at least a week for discussion and identification of any issues.
97105

98106
A member of [our management team](https://launchpad.net/~orsupervisors/+members) will read the request and follow the forum discussion being had by the community, and approve its direction if appropriate.
99107

0 commit comments

Comments
 (0)