diff --git a/README.rst b/README.rst index fb1b0b6..ba141a5 100644 --- a/README.rst +++ b/README.rst @@ -59,6 +59,8 @@ Jeff Knupp (|@jeffknupp|_) `describes how `_. It is based on `Terry Jones's proposal `__. It is licensed under the `MIT License `_. @@ -76,5 +78,5 @@ Coming soon. Issues ------ -If you find a bug, or want a feature, please `file an issue `__ (if it hasn't already been filed). -If you're willing and able, consider `contributing `__. +``txrc`` did what I needed when I needed it, but I have no interested in maintaining it further. +`Issues `__ and other `contributions `__ are no longer considered. diff --git a/docs/contrib.rst b/docs/contrib.rst index 435d12d..6018511 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -18,65 +18,4 @@ If those files are missing or appear to be modified from their originals, then p Contributing to ``txrc`` ======================== -There are several ways you can contribute. - -Filing Issues -------------- - -You can `file new issues `__ as you find them. -Please avoid duplicating issues. -These may be helpful: - -* `Tips to Write a Good Bug Report `__ by Soon Hui -* `Writing Effective Bug Reports `__ (PDF) by Elisabeth Hendrickson - -Submission Guidelines ---------------------- - -If you're willing and able, consider `submitting a pull request `__ (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 ` file: - - .. code-block:: rst - - ... - * `Gordon the Turtle `_ - ... - -* Try to follow the source conventions as you observe them. - (Note: I have purposely avoided aspects of `PEP8 `_, 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 ``./test``. - Tests can be run with ``tox [-e TOX_ENV]`` (requires `Tox `_) 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 `__ and `this `__ 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.**