Contributing

Contributions are welcome for this package!

There are many ways to contibute including:

Report Bugs

Report bugs at https://github.com/UBC-MDS/text_parsing_package/issues.

If you are reporting a bug, please follow the template guidelines. The more detailed your report, the easier and thus faster we can help you.

Write Documentation

We are always appreciative of additional documentation for text-parsing-package! Whether that is as part of the official documentation, in docstrings, or in other forums, just open an issue to share what you want to work on and we can help provide any additional information you might need.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/UBC-MDS/text_parsing_package/issues. If your feedback fits the format of one of the issue templates, please use that. Please remember that this package was developed as part of the UBC Master of Data Science program in partial fulfillment of the requirements for DSCI 524 Collaborative Data Science. As such, we may not be able to respond immediately.

Get Started!

Ready to contribute? Here’s how to set up text-parsing-package for local development.

  1. Fork the https://github.com/UBC-MDS/text_parsing_package repository on GitHub.

  2. Clone your fork locally (if you want to work locally)

    git clone git@github.com:your_name_here/text_parsing_package.git

  3. Create a conda environment to work in and make sure that hatch is installed alongside Python.

  4. Create a branch for local development using the default branch (typically main) as a starting point. Use doc as a prefix for your branch name.

    git checkout main
git checkout -b doc-name-of-your-documentation

    Now you can make your changes locally.

  5. Commit your changes and push your branch to GitHub. Please make commit messages clear.

    git add .
git commit -m "fix: summarize your changes"
git push -u origin doc-name-of-your-documentation

  6. Open the link displayed in the message when pushing your new branch in order to submit a pull request.

Pull Request Guidelines

Note that your pull request will automatically be checked by the full test suite. It needs to pass all of them before it can be considered for merging.

Code of Conduct

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