Branch: refs/heads/master Author: Steven Valsesia steven.valsesia@gmail.com Committer: Steven Valsesia steven.valsesia@gmail.com Date: Tue, 25 Mar 2014 12:28:45 UTC Commit: aaed5e028eaad0a212671949e235bed5020aa94f https://github.com/geany/geany/commit/aaed5e028eaad0a212671949e235bed5020aa9...
Log Message: ----------- Update the HACKING file, explain PR
Add the new way of contributing for geany.
Modified Paths: -------------- HACKING
Modified: HACKING 35 files changed, 32 insertions(+), 3 deletions(-) =================================================================== @@ -33,11 +33,20 @@ will be output to doc/reference/index.html. Alternatively you can view the API documentation online at http://www.geany.org/manual/reference/.
+Pull requests +------------ +Making pull requests on Github is the preferred way of contributing for geany. + +.. note:: For helping you to get started: https://help.github.com/articles/fork-a-repo + +See `Rules to contribute`_ for more information. + Patches ------- -We are happy to receive patches, but it's best to check with us by email -or mailing list whether a new feature is appropriate, and whether someone -is already working on similar code. +We are happy to receive patches, but the prefered way is to make a pull +request on our Github repository. If you don't want to make a pull request, +you can send your patches on the devel mailing list, but the rules are the same: +see `Rules to contribute`_ for more information.
In general it's best to provide git-formatted patches made from the current Git (see `Committing`_):: @@ -59,6 +68,26 @@ patch's description. Please make sure patches follow the style of existing code - In particular, use tabs for indentation. See `Coding`_.
+Rules to contribute +------------------- + +Keep in mind this is best to check with us by email on mailing list +whether a new feature is appropriate and whether someone is already +working on similar code. + +Please, make sure contributions you make follow these rules: + +* changes should be made in a dedicated branch for pull requests. +* only one feature should be in each pull request (or patch). +* pull requests (or patches) should not contain changes unrelated to the feature, +and commits should be sensible units of change. +* the submitter should squash together corrections that are part of +the development process, especially correcting your own mistakes. +* Please make sure your modifications follow the style of existing code: +see `Coding`_ for more information. + +See `Committing`_ for more information. + Windows tools ------------- * Git: http://git-scm.com/ and http://code.google.com/p/msysgit/
-------------- This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).