Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 2.37 KB

CONTRIBUTING.rst

File metadata and controls

82 lines (55 loc) · 2.37 KB
Raw

Contributing

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

Types of Contributions

Report Bugs

Report bugs at https://github.com/alejandrogallo/doi/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 / Implement Features

Look through the GitHub issues for bugs or feature requests. Anybody is welcome to submit a pull request for open issues.

Write Documentation

python-doi could always use more documentation, whether as part of the official python-doi 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/alejandrogallo/doi/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!

In short,

  1. Clone the repository from git@github.com:alejandrogallo/doi.git
  2. Fork the repo on GitHub to your personal account.
  3. Add your fork as a remote.
  4. Pull in the latest changes from the master branch.
  5. Create a topic branch
  6. Make your changes and commit them (testing locally)
  7. Push changes to the topic branch on your remote
  8. Make a pull request against the base master branch through the Github website of your fork.

The project contains a Makefile to help with development tasts. In your checked-out clone, do

$ make help

to see the available make targets.

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. Check https://travis-ci.org/alejandrogallo/doi/pull_requests and make sure that the tests pass for all supported Python versions.