Skip to content

Commit f19642e

Browse files
authored
Merge pull request #911 from twpol/feature/contributing-refactor
docs: Add refactoring as a special type of PR
2 parents 8a5a636 + 6834af0 commit f19642e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

Docs/Contributing.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you've got a feature suggestion for Open Rails, please report it in [our road
1818

1919
You are free to make any modifications to the Open Rails code that you like; that's how open source works. However, if you'd like your feature to be included in the official version, there is a process to ensure that the community agrees and to review the code for potential issues prior to inclusion.
2020

21-
In most cases, you can get started immediately with making the changes and creating a pull request. We do ask for some additional steps to be taken for some bugs and all new features, but they can come before or after the pull request. Please feel free to share ideas and proposals as pull requests!
21+
In most cases, you can get started immediately with making the changes and creating a pull request. We have _additional requirements_ for some bugs and all new features, but they can come before or after the pull request is created. Please feel free to share ideas and proposals as pull requests!
2222

2323
**Note:** You must fork the Open Rails repository before you start working on it. We do not allow you to push branches to the official repository.
2424

@@ -28,19 +28,25 @@ In most cases, you can get started immediately with making the changes and creat
2828

2929
If you'd like to improve the [documentation](./), [manual](../Source/Documentation/Manual), or [translations](../Source/Locales) you can get started immediately.
3030

31-
There are no requirements for the pull request.
31+
There are no additional requirements for the pull request.
3232

3333
### Contributed projects
3434

3535
If you'd like to improve the [contributed projects](../Source/Contrib) you can get started immediately.
3636

37-
There are no requirements for the pull request.
37+
There are no additional requirements for the pull request.
38+
39+
### Refactoring process
40+
41+
If you'd like to refactor the existing code you can get started immediately, but please have a look at our [architecture requirements](#architecture-requirements). We welcome architectural discussions on our [forum](http://www.elvastower.com/forums/index.php?/forum/256-developing-features/).
42+
43+
There are no additional requirements for the pull request.
3844

3945
### Bug process
4046

4147
If you'd like to fix a bug, you can get started immediately. If the fix turns out to be very small, you do not even need a bug report. Otherwise, you will need to make sure it has been reported on [our bug tracker on Launchpad](https://bugs.launchpad.net/or). If it has not, you can report the bug *and* fix it!
4248

43-
There are no requirements for creating the pull request.
49+
There are no additional requirements for _creating_ the pull request.
4450

4551
These things must be done in the required order:
4652

0 commit comments

Comments
 (0)