👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The catalyst project is maintained by Curiosity, and we welcome contributors to improve the codebase and flag any issues. This page will give you a quick overview of how things are organised and most importantly, how to get involved.
First, do a quick search to see if the issue has already been reported. If so, it's often better to just leave a comment on an existing issue, rather than creating a new one. Old issues also often include helpful tips and solutions to common problems.
You don't have to be an NLP expert to contribute, and we're happy
to help you get started. If you're new to catalyst, a good place to start is the
Getting Started guide, and the
help wanted
label, which we use to tag bugs and feature requests that are easy and
self-contained. If you've decided to take on one of these problems and you're
making good progress, don't forget to add a quick comment to the issue. You can
also use the issue to ask questions, or share your work in progress.
Remember that catalyst is released under the MIT license, so any code you contribute will be made available under the same license.
If you've made a contribution to catalyst, you should fill in the
Contributor Agreement to ensure that
your contribution can be used across the project. If you agree to be bound by
the terms of the agreement, fill in the template
and include it with your pull request, or submit it separately to
.github/contributors/
. The name of the file should be
your GitHub username, with the extension .md
. For example, the user
example_user would create the file .github/contributors/example_user.md
.