This is an automated email from the git hooks/post-receive script.
odyx pushed a commit to branch debian/master
in repository colobot.
commit 05515d225a34e06dea90da7f07ccc94f351fabab
Author: krzys_h <krzy...@interia.pl>
Date: Sun Feb 14 16:18:32 2016 +0100
Update CONTRIBUTING.md
---
CONTRIBUTING.md | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 35af974..c0b7871 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,21 +1,26 @@
# How to contribute
-**NOTE: This document is still not finished. Please feel free to suggest any
changes.**
So you want to contribute to Colobot: Gold Edition? That's awesome! Before you
start, read this page, it contains a lot of useful information on how to do so.
## General information
-Before you start, read more about technical details of the project. They can
be found on the [dev wiki](http://colobot.info/wiki/dev) and in our [Game
Design
Document](http://compiled.colobot.info/jenkins/job/colobot-gold-gdd/lastSuccessfulBuild/artifact/Colobot_Gold_Edition-Game_Design_Document.pdf)
([live editor](http://krzysh.pl:3000/project/545e90d99e8bceed2284797e))
+Before you start, read more about technical details of the project. They can
be found in our [Game Design
Document](http://compiled.colobot.info/jenkins/job/colobot-gold-gdd/lastSuccessfulBuild/artifact/Colobot_Gold_Edition-Game_Design_Document.pdf)
([live editor](http://krzysh.pl:3000/project/545e90d99e8bceed2284797e)).
+
+You may also find some useful information on the our (outdated) [dev
wiki](http://colobot.info/wiki/dev).
## Before you start coding
* If you want to fix a bug, please first check the related [issue on GitHub's
bug tracker](https://github.com/colobot/colobot/issues). If there isn't one,
make it.
-* If you want to add a new feature or make any change to gameplay, please
first discuss it either [on the forums](http://colobot.info/forum) or in the
related issue on GitHub. When your issue gets *enhancement* label (without the
*(proposed)* part), that means that your suggestion got accepted and is waiting
for somebody to work on it. Always wait for your suggestion to be accepted
before you start writing any code.
+* If you want to add a new feature or make any change to gameplay, please
first discuss it either [on the forums](http://colobot.info/forum) or in the
related issue on GitHub. When your issue gets *accepted* label, that means that
your suggestion got accepted and is waiting for somebody to work on it. Always
wait for your suggestion to be accepted before you start writing any code.
* Before you start, check *"Assignee"* field in the issue and read the
comments to see if nobody else is working on the same issue. If somebody is
assigned to it, but there was no activity for a long time, you can take it
over. Also, please post a comment on the issue that you want to help us, so
other people don't waste time working at that issue in the same time.
-## Coding guidelines
-See the [related page on dev wiki](http://colobot.info/wiki/dev/Coding_rules).
+## Coding style
+See the [related page on dev wiki](http://colobot.info/wiki/dev/Coding_rules)
for general guidelines, or [this
file](https://github.com/colobot/colobot-lint/blob/master/RULES.md) for
detailed description.
+
+See [colobot-lint repository](https://github.com/colobot/colobot-lint) for
automated tool that checks the coding style.
+
+If your pull request breaks the coding style, you will have to fix it before
it gets merged.
-## Submitting Pull Requests
-After you finish working on your issue and want your code to be merged into
the main repository, you should submit a Pull Request. Go to [this
page](https://github.com/colobot/colobot/pulls) and select "New pull request".
All pull request should ALWAYS be submitted to the *dev* branch. After your PR
gets reviewed by our development team, it'll be merged to *dev* branch, and
later to the *master* branch (on the next release).
+## Submitting pull requests
+After you finish working on your issue and want your code to be merged into
the main repository, you should submit a **pull request**. Go to [this
page](https://github.com/colobot/colobot/pulls) and select "New pull request".
All pull request should ALWAYS be submitted to the *dev* branch. After your PR
gets reviewed by our development team, it will be merged to *dev* branch, and
on the next release - to the *master* branch.
If you need more help, see [GitHub's help page on Pull
Requests](https://help.github.com/articles/using-pull-requests/).
--
Alioth's /usr/local/bin/git-commit-notice on
/srv/git.debian.org/git/pkg-games/colobot.git
_______________________________________________
Pkg-games-commits mailing list
Pkg-games-commits@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-games-commits
