From d544f94e25dd51bddaefaf6c8a146f820eae897d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 23 Oct 2017 11:38:48 +0200 Subject: [PATCH] Initial contribution guide. --- CONTRIBUTING.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 20 +++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..6c08af78 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,56 @@ +Contributing guide +################## + +Bug reports, feature requests or code contributions are always very welcome. +To make things easier, here are a few tips: + +Reporting bugs, requesting features +=================================== + +- Best way to report bugs and request new features is to use GitHub + `issues `_, but you can contact me + also any other way. + +Code contribution +================= + +- Setting up and using m.css for your own project is described in the + `documentation `_. +- Documentation and the website is essential part of the project and every + larger Pelican theme, plugin code or CSS contribution should be reflected + there. The website is contained inside `site/ `_ subdirectory and you + can build and start a local version of it using Pelican by executing + ``make devserver`` in there. The website is then available at + http://localhost:8000. See `Pelican usage documentation `_ + for more information. +- Documentation and website content is written in reStructuredText and + resides in `doc/ `_ subdirectory. Please verify that all your changes + there do not break the website build. +- Best way to contribute is by using GitHub `pull requests `_ + --- fork the repository and make pull request from feature branch. You can + also send patches via e-mail or contact me any other way. +- All your code will be released under license of the project (see `COPYING `_ + file for details), so make sure you and your collaborators (or employers) + have no problems with it. If you create new files, don't forget to add + license header (verbatim copied from other files) and don't forget to add + yourself to license header of files you added or significantly modified + (including documentation pages), for example:: + + /* + This file is part of m.css. + + Copyright © Vladimír Vondruš + Copyright © YEAR YOUR_NAME + + Permission is hereby granted, free of charge, to any person obtaining a + ... + +Contact +======= + +- Website --- http://mcss.mosra.cz +- GitHub --- https://github.com/mosra/m.css +- Gitter --- https://gitter.im/mosra/m.css +- Twitter --- https://twitter.com/czmosra +- E-mail --- mosra@centrum.cz +- Jabber --- mosra@jabbim.cz diff --git a/README.rst b/README.rst index 23ce0543..b540e784 100644 --- a/README.rst +++ b/README.rst @@ -46,9 +46,29 @@ possible. `Get Pelican plugins `_ +------- + *Still not convinced?* Head over to a `detailed explanation `_ of this project goals and design decisions. +CONTRIBUTING +============ + +Head over to the `contribution guide `_. + +CONTACT +======= + +Want to learn more about m.css? Found a bug or want to share an awesome idea? +Feel free to visit the project website or contact the author at: + +- Website --- http://mcss.mosra.cz +- GitHub --- https://github.com/mosra/m.css +- Gitter --- https://gitter.im/mosra/m.css +- Twitter --- https://twitter.com/czmosra +- E-mail --- mosra@centrum.cz +- Jabber --- mosra@jabbim.cz + LICENSE ======= -- 2.30.2