Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

104 lines (68 loc) · 3.35 KB
Raw

Contributing

Contributions are 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/quokkaproject/quokka/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Run pip freeze and paste you local versions of libraries
  • 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 is open to whoever wants to implement it.

Implement Features

Look through the roadmap file. Anything there is open to whoever wants to implement it, if you have any doubts about the item, open an issue or enter in GITTER Chat

Write Documentation

QuokkaProject could always use more documentation, whether as part of the official quokka source docs, in docstrings, or in project documentation website, or even on the web in blog posts, articles, and such.

To help writing documentation please go to https://github.com/quokkaproject/quokkaproject.github.io and follow instructions in README

Submit Feedback and ask for new features

The best way to send feedback is to file an issue at https://github.com/quokkaproject/quokka/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 Quokka CMS for local development.

  1. Fork the quokka repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/quokka.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 quokkadev
$ cd quokka/
$ pip install -r requirements/requirements.txt
$ pip install -r requirements/test.txt

Make sure you have MongoDB installed locally or in an accessible server

  1. Create a branch for local development:

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

    Now you can make your changes locally.

  2. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ make test

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

  4. Submit a pull request through the GitHub website or github CLI.

Pull Request Guidelines

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

  1. the Pull Request should be send against development branch only
  2. The pull request should include tests.
  3. If the pull request adds functionality, the docs should be updated.
  4. The pull request should work on Travis CI. Check https://travis-ci.org/quokkaproject/quokka/pull_requests and make sure that the tests pass for all supported Python versions.

Travis CI will include feedback in your Pull Requests