Changeset - r27694:2430e78190d9
[Not reviewed]
master
0 1 0
merni-ns - 11 months ago 2023-07-03 17:50:58
66267867+merni-ns@users.noreply.github.com
Doc: Link to coding style in the repository itself and add Discord link in addition to IRC
1 file changed with 5 insertions and 5 deletions:
0 comments (0 inline, 0 general)
CONTRIBUTING.md
Show inline comments
 
@@ -11,22 +11,22 @@ In return, they should reciprocate that 
 

	
 
## Using the issue tracker
 

	
 
The [issue tracker](https://github.com/OpenTTD/OpenTTD/issues) is the preferred channel for [bug reports](#bug-reports), but please respect the following restrictions:
 

	
 
* Please **do not** use the issue tracker for help playing or using OpenTTD.
 
Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), or the [forums](https://www.tt-forums.net/)
 
Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), [Discord](https://discord.gg/openttd), or the [forums](https://www.tt-forums.net/)
 

	
 
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
 

	
 
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
 
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead.
 
We reserve the right to delete comments which violate this rule.
 

	
 
* Please **do not** open issues or pull requests regarding add-on content in NewGRF, GameScripts, AIs, etc.
 
These are created by third-parties.  Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel) or the [forums](https://www.tt-forums.net/) to discuss these.
 
These are created by third-parties.  Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), [Discord](https://discord.gg/openttd), or the [forums](https://www.tt-forums.net/) to discuss these.
 

	
 
* Please use [the web translator](https://translator.openttd.org/) to submit corrections and improvements to translations of the game.
 

	
 

	
 
## Bug reports
 

	
 
@@ -105,13 +105,13 @@ Good pull requests—patches, improvements, new features—are a fantastic help.
 
Pull requests should fit with the [goals of the project](./CONTRIBUTING.md#project-goals).
 

	
 
**Please do ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
 

	
 
Every pull request should have a clear scope, with no unrelated commits.
 

	
 
[Code style](https://wiki.openttd.org/en/Development/Coding%20style) must be complied with for pull requests to be accepted; this also includes [commit message format](https://wiki.openttd.org/en/Development/Coding%20style#commit-message).
 
[Code style](./CODINGSTYLE.md) must be complied with for pull requests to be accepted; this also includes [commit message format](./CODINGSTYLE.md#commit-message).
 

	
 
Adhering to the following process is the best way to get your work included in the project:
 

	
 
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
 

	
 
```bash
 
@@ -133,13 +133,13 @@ 3. Create a new topic branch (off the ma
 
contain your feature, change, or fix:
 

	
 
```bash
 
git checkout upstream/master -b <topic-branch-name>
 
```
 

	
 
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](https://wiki.openttd.org/en/Development/Coding%20style#commit-message) or your code is unlikely to be merged into the main project.
 
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](./CODINGSTYLE.md#commit-message) or your code is unlikely to be merged into the main project.
 
Use Git's [interactive rebase](https://docs.github.com/en/get-started/using-git/about-git-rebase) feature to tidy up your commits before making them public.
 

	
 
5. Locally rebase the upstream development branch into your topic branch:
 

	
 
```bash
 
git fetch upstream
 
@@ -169,13 +169,13 @@ Continuous integration (CI) tools monito
 

	
 
The results of the CI tests will show on your pull request.
 

	
 
By clicking on Details you can further zoom in; in case of a failure it will show you why it failed.
 
In case of success it will report how awesome you were.
 

	
 
Tip: [commit message format](https://wiki.openttd.org/en/Development/Coding%20style#commit-message) is a common reason for pull requests to fail validation.
 
Tip: [commit message format](./CODINGSTYLE.md#commit-message) is a common reason for pull requests to fail validation.
 

	
 

	
 
### Are there any development docs?
 

	
 
There is no single source for OpenTTD development docs. It's a complex project with a long history, and multiple APIs.
 

	
0 comments (0 inline, 0 general)