This is an automated email from the git hooks/post-receive script.
odyx pushed a commit to branch upstream/latest
in repository colobot.
commit 27e3e061c22c5c40cccf93eb7f4cf90d7b6fceb2
Author: krzys-h <krzy...@interia.pl>
Date: Wed Mar 11 21:36:41 2015 +0100
Added CONTRIBUTING.md file
Still work in progress, feel free to suggest any changes.
Also updated some information in README.
---
CONTRIBUTING.md | 23 +++++++++++++++++++++++
README.md | 13 +++++++++----
2 files changed, 32 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..680d3f3
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# 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://krzysh.pl:3000/project/545e90d99e8bceed2284797e) <!--
TODO: once GDD is finished, we'll probably change this link to compiled PDF
file -->
+
+## 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 discus 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.
+* 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).
+
+## 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).
+
+If you need more help, see [GitHub's help page on Pull
Requests](https://help.github.com/articles/using-pull-requests/).
+
+## Need help?
+Ask on our official Freenode channel (#colobot @ irc.freenode.net) or on our
[forums](http://colobot.info/forum/). We're here to help :)
diff --git a/README.md b/README.md
index 02d2304..4ee2c9c 100644
--- a/README.md
+++ b/README.md
@@ -34,8 +34,11 @@ On some Linux distributions there are also distribution
packages available:
## Compiling and running the game
-If you want to compile colobot yourself, see
[INSTALL.md](https://github.com/colobot/colobot/blob/master/INSTALL.md) file.
+If you want to compile colobot yourself, see [INSTALL.md](INSTALL.md) file.
+## Contributing
+
+If you want to contribute to the project, see
[CONTRIBUTING.md](CONTRIBUTING.md) file. It contains a lot of useful
information on how to get started.
## Contact
@@ -55,7 +58,7 @@ To jest oficjalne repozytorium z kodem otwartoźródłowego
projektu Colobot: Go
Kod źródłowy zawarty tutaj został wydany przez Epsitec -- oryginalnego twórcę
gry -- na otwartej licencji (GPLv3). Kod został wydany i prawa nadane
specjalnie dla społeczności ICC w marcu 2012. Od tamtej pory, zajmowaliśmy się
dalszym rozwojem gry.
-Więcej informacji dla developerów projektu (po angielsku) można znaleźć na
[wiki dla developerów](htt://colobot.info/wiki/dev/) lub (po polsku) na [naszym
forum](http://colobot.info/forum/). Jednak źródłem najświeższych informacji są
nasze kanały IRC (patrz niżej).
+Więcej informacji dla developerów projektu (po angielsku) można znaleźć na
[wiki dla developerów](http://colobot.info/wiki/dev/) lub na [naszym
forum](http://colobot.info/forum/). Jednak źródłem najświeższych informacji są
nasze kanały IRC (patrz niżej).
To repozytorium zawiera jedynie kod źródłowy projektu. Gra wymaga jeszcze
plików danych, które są teraz udostępniane jako submoduł gita i hostowane w
[osobnym repozytorium](https://github.com/colobot/colobot-data).
@@ -83,14 +86,16 @@ Dla niektórych dystrybucji Linuksa, dostępne są pakiety
danej dystrybucji:
## Kompilacja i uruchomienie gry
-Jeżeli chcesz sam skompilować colobota, zobacz plik
[INSTALL.md](https://github.com/colobot/colobot/blob/master/INSTALL.md) (po
angielsku).
+Jeżeli chcesz sam skompilować colobota, zobacz plik [INSTALL.md](INSTALL.md)
(po angielsku).
+
+## Contributing
+Jeśli chcesz pomóc w pracach nad projektem, zobacz plik
[CONTRIBUTING.md](CONTRIBUTING.md) (po angielsku). Zawiera on wiele użytecznych
informacji, które pomogą ci zacząć.
## Kontakt
Jeżeli chcesz pomóc w projekcie, prosimy o kontakt na naszych kanałach IRC lub
[naszym forum](http://colobot.info/forum/).
-
### Kanały IRC
* [#colobot na Freenode](irc://freenode.net#colobot) - główny kanał
developerski (angielski);
--
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
