Skip to content

Commit

Permalink
Add the CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
frankrousseau authored Nov 1, 2023
1 parent 05e6a34 commit 01c9cef
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
## 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](https://github.com/cgwire/kitsu) repository.
- Follow our [X account](https://github.com/cgwire/kitsu).
- Follow our [Linkedin account](https://www.linkedin.com/company/cgwire/).
- Download our [trial Docker image](https://hub.docker.com/r/cgwire/cgwire).
- 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.
The community support for Kitsu is avalaible here too. Everyone is very friendly and would
be glad to meet you!

[Join the Animation/VFX Pipeline Discord](https://discord.com/invite/VbCxtKN)


## 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 into Kitsu or to vote
for already listed requests.

[Post a feature request ](https://cgwire.canny.io/)


## Bug reports

If you find any issue with Kitsu

[Report a bug](https://github.com/cgwire/kitsu/issues)


## 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]([POEditor platform](https://poeditor.com/join/project?hash=fpUejpWDVo)


## Improve the documentation

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

* Kitsu: https://github.com/cgwire/kitsu/tree/docs
* Zou: https://github.com/cgwire/zou/tree/docs
* Gazu: https://github.com/cgwire/gazu/tree/docs


## Code contributions

Of course, we enjoy receiving code contributions.
All contributions are welcomed as long as they respect the [C4
contract](https://rfc.zeromq.org/spec:42/C4). 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
[VueJS](https://vuejs.org/v2/guide/) framework extended with
the [Vuex](https://vuex.vuejs.org) plugin.

To install the development environment, follow [the dedicated guide](https://kitsu.cg-wire.com/development-environment/).

0 comments on commit 01c9cef

Please sign in to comment.