diff options
| author | Juuso Lapinlampi <wub@partyvan.eu> | 2015-10-09 21:18:45 +0200 |
|---|---|---|
| committer | Juuso Lapinlampi <wub@partyvan.eu> | 2015-10-09 21:18:45 +0200 |
| commit | cba9ff1b194a99084d47ce0cace35ba32035175d (patch) | |
| tree | 7f409d7b13dc038d575756430db9088b610b177d /README.md | |
| parent | 0e0d9c3915c6a5b344bf49f87b1a4c52ad6c2022 (diff) | |
Add "Contributing" section to README.md
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/
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -58,6 +58,23 @@ help. - IRC: `#pantsucat` on Partyvan (`irc.partyvan.eu`) - Email: <hostmaster@pantsu.cat> +## 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 |
