Skip to content

Latest commit

 

History

History
executable file
·
92 lines (49 loc) · 2.27 KB

File metadata and controls

executable file
·
92 lines (49 loc) · 2.27 KB

Contributing to Textstat

Thank you for checking out Textstat, and for wanting to make a contribution!

Reading and following these guidelines means we will all be on the same page, and helps make the contribution process easy for everyone invloved.

Contents

Code of conduct

It's important that everyone feels safe and welcome when contributing to Open Source. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Types of contributions

There are many ways you can contribute to the Textstat project, not just code. Some of the ways you could contribute: proof reading documentation, improving documentation, validating test results, reading and summarising academic papers, answering questions.

Project processes

How to get questions answered

How to request new features

How to help improve documentation

How to report a bug

Code contributions

How to set up the development environment

How to find issues to work on

Development process

Long running branches

How to build the project

How to test the project

  • Where to find tests
  • How to add new tests

Style guidelines

Submitting pull requests

  • How code will be reviewed/approved
  • How feedback is expected to be addressed
  • Expected response timeframes