Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

76 lines (46 loc) · 2.66 KB

Contributing

As you guess we enjoy any contribution! You will find below how you can help the Kitsu project to get better.

Spread the word

Making the project more visible helps a lot and doesn't takes much of your time. For that, you have several ways to contribute:

  • Star the GitHub repository.
  • Follow our X account.
  • Follow our LinkedIn account.
  • Download our trial Docker image.
  • Come to our meetups.
  • Organize a meetup dedicated to Kitsu.
  • Write a social media post about us.
  • Write a blog post about us.
  • Talk about Kitsu to your colleagues and friends.

Meet the community

Our community chat and forum is available on Discord. The topics discussed are wider than Kitsu discussion, they cover everything related to pipelines. Community support for Kitsu is available here, too. Everyone is amiable and would be glad to meet you!

Join the Animation/VFX Pipeline Discord

Feature requests

Another great way to contribute is to propose new feature ideas. For that, we use the Canny platform. It allows you to post new capabilities you would like to see in Kitsu or to vote for already listed requests.

Post a feature request

Bug reports

If you find any issue with Kitsu

Report a bug

Translations

If you want to contribute to translations, we have an account on the POEditor platform that you can use to participate.

Contribute to the translation

Improve the documentation

You can contribute to the documentation of Kitsu by correcting sentences or adding information to it. Find below the list of the documentation repositories:

Code contributions

Of course, we enjoy receiving code contributions. All contributions are welcomed as long as they respect the C4 contract. You can find tickets waiting for a fix on our GitHub repository and feature requests on our Canny page.

The Kitsu code is written with JavaScript (ES6+) and is based on the Vue.js framework extended with the Vuex plugin.

To install the development environment, follow the dedicated guide.