Skip to content

Commit

Permalink
docs(fork): Update to indicate this fork #20
Browse files Browse the repository at this point in the history
This project is a fork of https://github.com/audreyfeldroy/cookiecutter-pypackage.
Any references to help, etc., will point to the original fork, possibly
confusing potential users.

WIP #20
  • Loading branch information
imAsparky committed Sep 1, 2021
1 parent 9cf4777 commit f287b06
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions CONTRIBUTING.rst
Expand Up @@ -13,7 +13,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/audreyr/cookiecutter-pypackage/issues
Report bugs at https://github.com/imAsparky/cookiecutter-py3-package/issues

If you are reporting a bug, please include:

Expand All @@ -36,15 +36,15 @@ and "help wanted" is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

Cookiecutter PyPackage could always use more documentation, whether as part of
Cookiecutter Py3-Package could always use more documentation, whether as part of
the official docs, in docstrings, or even on the web in blog posts, articles,
and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at
https://github.com/audreyr/cookiecutter-pypackage/issues.
https://github.com/imAsparky/cookiecutter-py3-package/issues.

If you are proposing a new feature:

Expand All @@ -56,11 +56,11 @@ If you are proposing a new feature:
Get Started!
------------

Ready to contribute? Here's how to set up `cookiecutter-pypackage` for local
Ready to contribute? Here's how to set up `cookiecutter-py3-package` for local
development. Please note this documentation assumes you already have
`virtualenv` and `Git` installed and ready to go.
`virtualenv_` and `Git_` installed and ready to go.

1. Fork the `cookiecutter-pypackage` repo on GitHub.
1. Fork the `cookiecutter-py3-package` repo on GitHub.

::

Expand All @@ -69,7 +69,7 @@ development. Please note this documentation assumes you already have
.. code-block:: bash
$ cd path_for_the_repo
$ git clone git@github.com:YOUR_NAME/cookiecutter-pypackage.git
$ git clone git@github.com:YOUR_NAME/cookiecutter-py3-package.git
::

Expand All @@ -79,14 +79,14 @@ development. Please note this documentation assumes you already have

.. code-block:: bash
$ virtualenv cookiecutter-pypackage-env
$ source cookiecutter-pypackage-env/bin/activate
$ virtualenv cookiecutter-py3-package-env
$ source cookiecutter-py3-package-env/bin/activate
This should change the shell to look something like:

.. code-block:: bash
(cookiecutter-pypackage-env) $
(cookiecutter-py3-package-env) $
::

Expand All @@ -110,7 +110,7 @@ development. Please note this documentation assumes you already have
::

6. The next step would be to run the test cases. `cookiecutter-pypackage` uses
6. The next step would be to run the test cases. `cookiecutter-py3-package` uses
pytest, you can run PyTest. Before you run pytest you should ensure all
dependancies are installed:

Expand Down Expand Up @@ -171,8 +171,8 @@ Before you submit a pull request, check that it meets these guidelines:
new functionality into a function with a docstring, and add the feature to
the list in README.rst.

3. The pull request should work for Python 3.6 and 3.7, 3.8 and for PyPy. Check
https://travis-ci.org/audreyr/cookiecutter-pypackage/pull_requests and
3. The pull request should work for Python 3.6, 3.7, 3.8, 3.9 and PyPy. Check
https://github.com/imAsparky/cookiecutter-py3-package/pulls and
make sure that the tests pass for all supported Python versions.

Add a New Test
Expand Down Expand Up @@ -230,7 +230,6 @@ To write and run your new test, follow these steps:
6. Rerun your test and confirm that your test passes. If it passes,
congratulations!

.. cookiecutter: https://github.com/audreyr/cookiecutter-pypackage
.. virtualenv: https://virtualenv.pypa.io/en/stable/installation
.. git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
.. cookiecutter: https://github.com/imAsparky/cookiecutter-py3-package
.. _virtualenv: https://virtualenv.pypa.io/en/stable/installation
.. _Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

0 comments on commit f287b06

Please sign in to comment.