github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance feedback and contributing guidelines

Browse source 
Many folks ask for help (via IRC or filing GitHub issues) without
sufficient detail and/or without first determining if the answers to
their questions might be better sourced elsewhere. These
documentation changes encourage users to follow certain guidelines
when reaching out for help.
This commit is contained in:
Ondrej Grover 2014-05-26 12:32:05 +02:00 • committed by Justin Mayer
commit 2e1b16826b
5 changed files with 111 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/contribute.rst
View file

@ -1,13 +1,13 @@
How to contribute
#################
Contributing and Feedback Guidelines
####################################
There are many ways to contribute to Pelican. You can improve the
documentation, add missing features, and fix bugs (or just report them). You
can also help out by reviewing and commenting on
`existing issues <https://github.com/getpelican/pelican/issues>`_.
Don't hesitate to fork Pelican and submit a pull request on GitHub. When doing
so, please adhere to the following guidelines.
Don't hesitate to fork Pelican and submit an issue or pull request on GitHub.
When doing so, please adhere to the following guidelines.
.. include:: ../CONTRIBUTING.rst
@ -47,16 +47,6 @@ Or using ``pip``::
$ pip install -e .
Coding standards
================
Try to respect what is described in the `PEP8 specification
<http://www.python.org/dev/peps/pep-0008/>`_ when making contributions. This
can be eased via the `pep8 <http://pypi.python.org/pypi/pep8>`_ or `flake8
<http://pypi.python.org/pypi/flake8/>`_ tools, the latter of which in
particular will give you some useful hints about ways in which the
code/formatting can be improved.
Building the docs
=================

11
docs/faq.rst
View file

@ -6,16 +6,7 @@ Here are some frequently asked questions about Pelican.
What's the best way to communicate a problem, question, or suggestion?
======================================================================
If you have a problem, question, or suggestion, please start by striking up a
conversation on `#pelican on Freenode <irc://irc.freenode.net/pelican>`_.
Those who don't have an IRC client handy can jump in immediately via
`IRC webchat <http://webchat.freenode.net/?channels=pelican&uio=d4>`_. Because
of differing time zones, you may not get an immediate response to your
question, but please be patient and stay logged into IRC — someone will almost
always respond if you wait long enough (it may take a few hours).
If you're unable to resolve your issue or if you have a feature request, please
refer to the `issue tracker <https://github.com/getpelican/pelican/issues>`_.
Please read our :doc:`feedback guidelines <contribute>`.
How can I help?
================

18
docs/index.rst
View file

@ -47,20 +47,10 @@ Source code
You can access the source code at: https://github.com/getpelican/pelican
Feedback / Contact us
---------------------
How to get help, contribute, or provide feedback
------------------------------------------------
If you want to see new features in Pelican, don't hesitate to offer suggestions,
clone the repository, etc. There are many ways to :doc:`contribute<contribute>`.
That's open source, dude!
Send a message to "authors at getpelican dot com" with any requests/feedback.
For a more immediate response, you can also join the team via IRC at
`#pelican on Freenode`_ — if you don't have an IRC client handy, use the
webchat_ for quick feedback. If you ask a question via IRC and don't get an
immediate response, don't leave the channel! It may take a few hours because
of time zone differences, but if you are patient and remain in the channel,
someone will almost always respond to your inquiry.
See our :doc:`feedback and contribution submission guidelines <contribute>`.
Documentation
-------------
@ -93,5 +83,3 @@ Documentation
.. _`Pelican documentation`: http://docs.getpelican.com/latest/
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
.. _`Pelican plugins`: https://github.com/getpelican/pelican-plugins
.. _`#pelican on Freenode`: irc://irc.freenode.net/pelican
.. _webchat: http://webchat.freenode.net/?channels=pelican&uio=d4