From cba9ff1b194a99084d47ce0cace35ba32035175d Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 19:18:45 +0000 Subject: Add "Contributing" section to README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Worthy read: "Top ten reasons why I won’t use your open source project" by Adam Stacoviak. https://changelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/ --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0353c16..11cadb1 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,23 @@ help. - IRC: `#pantsucat` on Partyvan (`irc.partyvan.eu`) - Email: +## Contributing + +For source code changes, please submit `git-format-patch(1)` formatted patches +by email or come talk to us on IRC. See "Getting help". At this time, we do not +use the issue tracker on `git.pantsu.cat` to track issues/pull requests. + +We'd really like if you can take some time to make sure your coding style is +consistent with the project. Pomf follows [PHP +PSR-2](http://www.php-fig.org/psr/psr-2/) and [Airbnb JavaScript +(ES5)](https://github.com/airbnb/javascript/tree/master/es5) (`airbnb/legacy`) +coding style guides. We use ESLint and PHPCS tools to enforce these standards. + +You can also help by sending us feature requests and writing documentation and +tests. + +Thanks! + ## Credits Pomf was created by Eric Johansson and Peter Lejeck for -- cgit v1.2.3