Skip to content
This repository has been archived by the owner on Apr 1, 2020. It is now read-only.

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
zrzka committed Sep 30, 2017
1 parent 750d3ae commit 6917978
Show file tree
Hide file tree
Showing 5 changed files with 116 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/autobuild.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
if [ -d build ]; then
rm -rf build
fi
sphinx-autobuild -b html source build/html
sphinx-autobuild -b html --open-browser --delay 5 -z ../../blackmamba source build/html
40 changes: 39 additions & 1 deletion docs/source/contribution.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,45 @@
.. _contribution:


############
Contribution
############

TODO
There are several areas where you can help.


Documentation
=============

I'm not native English speaker and some of my sentences sound weird.
Fork `blackmamba <https://github.com/zrzka/blackmamba>`_ repository,
update `documentation <https://github.com/zrzka/blackmamba/tree/master/docs/source>`_ and
open pull request. Will happily merge it.

Documentation does use `reStructuredText <http://docutils.sourceforge.net/rst.html>`_.
Here's `quick start <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ guide.

Why not Markdown? reStructuredText is more powerful and allows me to use links, references and
other stuff.


Testing
=======

If you find a bug, please do not hesitate to `file an issue <https://github.com/zrzka/blackmamba/issues>`_.
I'm unable to test everything.


Development
===========

Black Mamba is developed in my spare time. I have a full time job, love it and I don't
have much time to enhance it. If you'd like to help, see :ref:`development`.


Questions
=========

Do you have a question? `File an issue <https://github.com/zrzka/blackmamba/issues>`_, I'll add
``question`` tag and will answer it. Or you can send me direct message on
`Twitter <https://twitter.com/robertvojta>`_.
47 changes: 47 additions & 0 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. _development:

###########
Development
###########


Style
=====

There's no defined style for development. Just stick with the same style you see
in other blackmamba modules.


Pull requests
=============

Pull requests must pass ``flake8`` checks:

.. code-block:: shell
flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
flake8 . --count --max-complexity=10 --max-line-length=127 --statistics
Pull requests must pass tests:

.. code-block:: shell
PYTHONPATH=. pytest tests
Consult `.travis.yml <https://github.com/zrzka/blackmamba/blob/master/.travis.yml>`_ for more details.


Existing issues
===============

Let me know if you'd like to work on `something <https://github.com/zrzka/blackmamba/issues>`_.
To avoid situation where I already started working on it.


New ideas
=========

I'm open to new ideas as well. Please, `file an issue <https://github.com/zrzka/blackmamba/issues>`_
first, we can discuss it and then you can implement it.
27 changes: 27 additions & 0 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _faq:


###
FAQ
###


General
=======


Are you affiliated with Pythonista?
-----------------------------------

No. It's a completely separate project. Although I discuss some of my ideas
with `Ole <https://twitter.com/olemoritz>`_ (Pythonista author) from time to time.


What if some feature will be added to Pythonista?
-------------------------------------------------

I'm perfectly okay with this and will be happy if something from Black Mamba
will be natively supported by the Pythonista. That's also the reason why I filled
`so many issues <https://github.com/omz/Pythonista-Issues/issues/created_by/zrzka>`_.

These features will be removed from Black Mamba after some period if this happens.
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ Welcome stranger. Use one of the following links to continue.
user/index
reference/index
contribution
development
faq

0 comments on commit 6917978

Please sign in to comment.