Skip to content

Latest commit

 

History

History
130 lines (84 loc) · 3.95 KB

CONTRIBUTING.rst

File metadata and controls

130 lines (84 loc) · 3.95 KB
Raw

Contributing

Contributions are always welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/scrapinghub/spidermon/issues.

If you are 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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with Type: Bug is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with Type: Enhancement is open to whoever wants to implement it.

Write Documentation

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

Anything tagged with Type: Docs indicates some feature of Spidermon we identified needing more docs and is open to whoever wants to implement it,

Don't be limited to these issues if you believe that other parts need to be better documented or fixed.

Submit Feedback and Propose New Features

The best way to send feedback is to file an issue at https://github.com/scrapinghub/spidermon/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 contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up spidermon for local development.

  1. Fork the spidermon repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/spidermon.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv spidermon
$ cd spidermon/

  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, check that your changes pass the tests, including testing other Python versions with tox:

    $ pip install -r requirements.txt
$ pip install -r requirements-docs.txt
$ tox

  6. Install the git hook scripts from pre-commit:

    $ pre-commit install

  7. If you changed something related to docs, make sure it compiles properly:

    $ cd docs
$ make html

    Now you can go to spidermon/docs/build and open index.html.

  8. 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

  9. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated.
  3. Check https://travis-ci.org/scrapinghub/spidermon/pull_requests and make sure that the tests pass for all supported Python versions.
  4. Follow the core developers' advice which aim to ensure code's consistency regardless of variety of approaches used by many contributors.
  5. In case you are unable to continue working on a PR, please leave a short comment to notify us. We will be pleased to make any changes required to get it done.