diff options
| author | XhmikosR <xhmikosr@users.sourceforge.net> | 2012-10-05 15:11:19 +0400 |
|---|---|---|
| committer | XhmikosR <xhmikosr@users.sourceforge.net> | 2012-10-05 22:43:16 +0400 |
| commit | b5de74e6abc278416d05251dcdd9fc37a5cddc93 (patch) | |
| tree | 03b3e214223aa5a216bea3f2b589c1e42d873c99 /CONTRIBUTING.md | |
| parent | 978a3afa50141e41251d61132f4fc8787e4bbcc6 (diff) | |
add core.autocrlf info in CONTRIBUTING.md and break long lines
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c40d5b874..3777fcedf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,12 @@ ## Reporting Issues 1. Make sure you have a [SourceForge account](http://sourceforge.net/account/login.php) -2. Please search our [Trac](http://sourceforge.net/apps/trac/mpc-hc/report/1) for your problem (there's a good chance that someone already reported it.) +2. Please search our [Trac](http://sourceforge.net/apps/trac/mpc-hc/report/1) + for your problem (there's a good chance that someone already reported it.) 3. In case you found a match, please try to provide as much info as you can so we have better picture about what the real problem is and how to fix it ASAP. -4. If you didn't find tickets with problem similar to yours then please open a [new ticket](http://sourceforge.net/apps/trac/mpc-hc/ticket/newticket) +4. If you didn't find tickets with problem similar to yours then please open a + [new ticket](http://sourceforge.net/apps/trac/mpc-hc/ticket/newticket) * Be descriptive as much as you can. * Provide screenshots, samples, system/hardware information. @@ -18,7 +20,8 @@ If you want to help, here's what you need to do. 1. Make sure you have a [GitHub account](https://github.com/signup/free). 2. [Fork](https://github.com/mpc-hc/mpc-hc/fork_select) the repository you wish to help on. 3. Create a new topic branch to contain your feature, change, or fix. -4. Make sure that your changes adhere to the current coding conventions used +4. Set core.autocrlf to true: `git config core.autocrlf true` +5. Make sure that your changes adhere to the current coding conventions used throughout the project - indentation, accurate comments, etc. For the style part we use AStyle, so please run `docs/run_astyle.bat` before you push your changes. -5. [Open a Pull Request](https://github.com/mpc-hc/mpc-hc/pulls) with a clear title and description. +6. [Open a Pull Request](https://github.com/mpc-hc/mpc-hc/pulls) with a clear title and description. |