Contributing

Contributions to the project are welcome!

Contribution guidelines

Generally, we ask that contributors use a standard fork-branch-pull request workflow.

• Create a fork of the main twitter-text-python project.
• Clone the repo to your local workstation.
• Create a new branch with a descriptive name, i.e. adding-conformance-tests and make your changes there.
• Create a new Issue in the upstream Github project (if one does not already exist) to discuss the proposed changes.
• Add and run the unit tests if relevant.
• Submit a pull request and reference the issue/ticket.
• If pull request is accepted and merged, you can delete your fork.

New contributors

Be sure to take a look at the existing issues to see if there are any open bugs or TODO's that require attention. For existing issues it's often best to leave a comment before submitting a pull request in case someone else is already working on it.