Skip to content

Latest commit

 

History

History
122 lines (73 loc) · 7.66 KB

CONTRIBUTING.md

File metadata and controls

122 lines (73 loc) · 7.66 KB

How can I contribute to Taiga?


Developer Certificate of Origin + License

By contributing to Taiga Agile LLC., You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Taiga Agile LLC. Except for the license granted herein to Taiga Agile LLC. and recipients of software distributed by Taiga Agile LLC., You reserve all right, title, and interest in and to Your Contributions.

All Contributions are subject to the following DCO + License terms.

DCO + License

This notice should stay as the first item in the CONTRIBUTING.md file.


We will be very happy to help us to improve Taiga, there are many different ways to contribute to Taiga's development, just find the one that best fits with your skills. Here are the guidelines we'd like you to follow.

Our Code of Conduct

Help us keep the Taiga Community open and inclusive. Please read and follow our Code of Conduct.

Our License

Every code patch accepted in Taiga codebase is licensed under AGPL v3.0. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Setup problems

If you follow our setup guide and you have some problem, please tell with us in our mailing list.

Sent us your feedback or questions

If you want to send us your feedback or have some questions about how to use Taiga, please direct these to our mailing list. If it's related to our SaaS https://taiga.io please write us to our support email [email protected].

Remember that you can find some help in our support pages.

Did you find an issue or bug?

If you find an issue using the app (UX or UI bug) or reading our source code and it's not on our Bug list at Taiga.io, please report it:

Even better: you can submit a Pull Request with a fix.

Please, before reporting a bug write down

  • explain why this is a bug for you
  • how can we reproduce it
  • your operating System
  • your browser and version
  • if it's possible, a screenshot

Sometimes it takes less time to fix a bug if the developer knows how to find it and we will solve your problem as fast as possible.

Localization Issue: Taiga use Transifex to manage the i18n files so don't submit a pull request to those files (except -en.json), to fix it just access our team of translators, set up an account in the Taiga Transifex project and start contributing.

Propose some feature or enhancement

You can propose a new enhancement to our mailing list or review and upvote in the existing list of enhancements in Taiga.io.

If you would like to implement it by yourself consider what kind of change it is:

Small Changes

It can be crafted and submitted to the GitHub Repositories as a Pull Request.

Major Changes

Before contributing with a major change to Taiga it should be discussed first with the Taiga Team so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. Please, contact us in the mailing list or via [email protected].

We have defined a concrete workflow for this changes:

  1. User Story: Send us a complete description of the functionality you'd like to develop, how it should work, for which profiles, as if you were writing a User Story. Please include some ideas of what would be a definition of Done of the User Story. The team will review it, decide whether or not it could make it into Taiga Core. If not, you can always write a plugin.
  2. Mentorship: If accepted, Taiga team will help you, and a person from the team will be your contact in the development process. The Story will be visible in the Taiga Kanban
  3. User Experience: The functionality will require some wireframes or ideas to be developed correctly. A good UX its an essential part of Taiga success. You should create a user experience proposal and the Taiga UX team will help you.
  4. Design: The design should respect the Taiga style. Try to reproduce other areas of the site. The taiga design team will review this proposal as well.
  5. Development: The last step is the development. Remember to add unit and integration test in taiga-back code and unit and e2e test for taiga-front part. We have the API well documented too in taiga-doc.
  6. Pull request: Remember to add a good description and screenshots are welcome too. Once the pull request is done, someone else from the team will review the code to ensure that it fits with the good practices and styles. If it does, the PR will be merged and will be on the next Taiga release.

If you think you are not able to do one or more of the parts of the process, your contribution is still welcome, but we cannot ensure that it will make it soon into the Taiga core anytime soon. It will depend on our priority backlog.

Thanks a lot! It is really great that we could make Taiga better with the help of the community.

Contrib plugins

Taiga support contrib plugins to add or overwrite some functionalities. You can find some example in our organization at GitHub.

Improve the documentation

We are gathering lots of information from our users to build and enhance our documentation. If you use the documentation to install or develop with Taiga and find any mistakes, omissions or confused sequences, it is enormously helpful to report it. Or better still, if you believe you can author additions, please make a pull-request to taiga project.

Currently, we have authored three main documentation hubs:

  • Taiga Setup/Dev documentation: If you need to install Taiga on your own server, this is the place to find some guides or our API documentation and reference for developing from Taiga API.
  • Taiga User documentation: This page is intended to be the support reference page for the users. If you find any mistake, please report or fix it.