Skip to content
This repository has been archived by the owner on Jun 14, 2020. It is now read-only.

Latest commit

 

History

History
33 lines (24 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.53 KB
Raw

CONTRIBUTING

Adam QAS is a community-maintained project and we happily accept contributions.

If you wish to add a new feature or fix a bug:

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the Adam QAS repository on Github to start making your changes.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.rst.
$ git checkout dev -b feature/my-new-feature 
$ git pull origin master

Note: Follow PEP8 codding style.

Running the tests

We use some external dependencies, multiple interpreters and code coverage analysis while running test suite. Our Makefile handles much of this for you as long as you’re running it inside of a virtualenv:

$ pytest tests

Our test suite runs continuously on Travis CI with every pull request to master.

HELP REQUIRED

To find where you can help, search for the following tags:

  • #TODO: The tasks which are pending or yet not taken up
  • #FIXME: The tasks which require some attending to do
  • #HELP: The tasks which are require some help

You can also help in making the Wikipedia parser more robust by adding more XPath filters that remove irrelevant information or extract and format relevant information.