Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Commit

Permalink
Obituary
Browse files Browse the repository at this point in the history
  • Loading branch information
posita committed Jun 11, 2020
1 parent 572bfc5 commit afa2987
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 61 deletions.
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ Jeff Knupp (|@jeffknupp|_) `describes how <https://www.jeffknupp.com/blog/2013/0

..
**UPDATE: This project is no longer maintained or supported. Issues, pull requests, and other contributions will be ignored.**

``modwalk`` is TODO.
It is licensed under the `MIT License <https://opensource.org/licenses/MIT>`_.
See the |LICENSE|_ file for details.
Expand All @@ -80,5 +82,5 @@ Coming soon.
Issues
------

If you find a bug, or want a feature, please `file an issue <https://github.com/posita/modwalk/issues>`__ (if it hasn't already been filed).
If you're willing and able, consider `contributing <https://modwalk.readthedocs.org/en/master/contrib.html>`__.
``modwalk`` did what I needed when I needed it, but I have no interested in maintaining it further.
`Issues <https://github.com/posita/modwalk/issues>`__ and other `contributions <https://modwalk.readthedocs.org/en/master/contrib.html>`__ are no longer considered.
60 changes: 1 addition & 59 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,62 +18,4 @@ If those files are missing or appear to be modified from their originals, then p
Contributing to ``modwalk``
===========================

There are several ways you can contribute.

Filing Issues
-------------

You can `file new issues <https://github.com/posita/modwalk/issues>`__ as you find them.
Please avoid duplicating issues.
`"Writing Effective Bug Reports" by Elisabeth Hendrickson <http://testobsessed.com/wp-content/uploads/2011/07/webr.pdf>`__ (PDF) may be helpful.

Submission Guidelines
---------------------

If you're willing and able, consider `submitting a pull request <https://github.com/posita/modwalk/pulls>`__ (PR) with a fix.
There are only a few guidelines:

* If it isn't already there, please add your name (and optionally your GitHub username, email, website address, or other contact information) to the :doc:`CREDITS <CREDITS>` file:

.. code-block:: rst
...
* `Gordon the Turtle <https://github.com/GordonTheTurtle>`_
...
* Try to follow the source conventions as you observe them.
(Note: I have purposely avoided aspects of `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_, in part because I have adopted conventions developed from my experiences with other languages, but mostly because I'm growing older and more stubborn.)

..
* Provide tests where feasible and appropriate.
At the very least, existing tests should not fail.
(There are exceptions, but if there is any doubt, they probably don't apply.)

Unit tests live in ``./tests``.
Tests can be run with ``tox [-e TOX_ENV]`` (requires `Tox <https://tox.readthedocs.org/en/latest/>`_) or ``"${PYTHON:-python}" setup.py test``.

There are two helper scripts that may be of interest.
To set up a virtual environment (via ``virtualenv``) for development and to run unit tests using `Tox`_ from that virtual environment, you can do the following:

.. code-block:: sh
( . ./helpers/venvsetup.sh && ./helpers/runtests.sh [-e TOX_ENV] )
* If you need me, mention me (|@posita|_) in your comment, and describe specifically how I can help.

.. |@posita| replace:: **@posita**
.. _`@posita`: https://github.com/posita

* If you want feedback on a work-in-progress (WIP), create a PR and prefix its title with something like, "``NEED FEEDBACK -``".

..
* If your PR is still in progress, but you aren't blocked on anything, prefix the title with something like, "``WIP -``".

..
* Once you're ready for a merge, resolve any merge conflicts, squash your commits, and provide a useful commit message.
(`This <https://robots.thoughtbot.com/git-interactive-rebase-squash-amend-rewriting-history>`__ and `this <http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html>`__ may be helpful.)
Then prefix the PR's title to something like, "``READY FOR MERGE -``".
I'll try to get to it as soon as I can.
**UPDATE: This project is no longer maintained or supported. Issues, pull requests, and other contributions will be ignored.**

0 comments on commit afa2987

Please sign in to comment.