Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. (This page modified from https://github.com/pyOpenSci/cookiecutter-pyopensci)

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/McTavishLab/physcraper/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 “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Physcraper could always use more documentation, whether as part of the official Physcraper 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/McTavishLab/physcraper/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 contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up Physcraper for local development.

  1. Fork the Physcraper repo on GitHub https://github.com/McTavishLab/physcraper
  2. Clone your fork locally:
$ git clone git@github.com:your_name_here/physcraper.git
  1. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv venv-physcraper
$ cd physcraper/
$ pip install -e .
  1. Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you’re done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox:
$ pytest tests
  1. Use Pylint to check your code. Move to the “bin” or “physcraper” directory to use the .pylintrc config file, then run:
$ pylint insert_name_of_module_here.py
  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
  1. Submit a pull request through the GitHub website.

Extra: Count the number of functions in any given module

from inspect import getmembers, isfunction
foos = [o for o in getmembers(physcraper) if isfunction(o[1])]
len(foos)

Updating the README

The README.Rmd file generates the README.md file, which in turn generates what is shown on Physcraper’s home page at its GitHub repository, and PyPI’s description.

To update README.md from README.Rmd file, you need R and the rmarkdown package installed to run:

R -e 'rmarkdown::render("README.Rmd")'

The index.rst file that lives in the docs/source/ folder controls the home page at readthedocs, which is updated automatically as you push to GitHub.

To update any of these, you have to modify, as needed, README.Rmd and docs/source/index.rst, as well as the following .md files living in the docs/mds/ folder:

  • intro-badges.md
  • intro-logo.md
  • intro-part1.md
  • citation.md
  • license.md
  • contact.md
  • updating-the-readme.md, aka, this file ✨

To create new sections, you just need to create new .md files in docs/mds/ and make sure to add them to README.Rmd and docs/source/index.rst

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. Put your 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, 3.7 and 3.8, and for PyPy. Check https://travis-ci.org/McTavishLab/physcraper/pull_requests and make sure that the tests pass for all supported Python versions.

Code of Conduct

Please note that the Physcraper project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.