Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 3.31 KB

CONTRIBUTING.rst

File metadata and controls

115 lines (71 loc) · 3.31 KB
Raw

Contributing/Development

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

MyAnimeList Scraper could always use more documentation, whether as part of the official MyAnimeList Scraper docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/QasimK/mal-scraper/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

We follow (and our tests check):

To set up mal-scraper for local development:

  1. Fork mal-scraper (look for the "Fork" button).

  2. Clone your fork locally:

    git clone [email protected]:your_name_here/mal-scraper.git

  3. Ensure Pipenv is installed on your computer and install the development packages:

    pipenv install --dev

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, run all the checks, doc builder and spell checker with tox one command:

    pipenv run tox
The newly built HTML docs can be found within the dist folder in the repo.

  1. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you're developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there's new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don't have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though ...

Tips

To run the test-suite quickly:

pytest

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To skip Python environments that you do not have installed:

tox --skip-missing-interpreters

To run all the test environments in parallel (you need to pip install detox):

detox

PyPI Submission

  1. Bump Version bumpversion minor
  2. Upload to Pypi python setup.py sdist bdist_wheel upload -r pypi