Welcome! We are very excited that you are interested in contributing to Coral.
This document is a companion to help you approach contributing. If it does not do so, please let us know how we can improve it!
By contributing to this project you agree to the Code of Conduct.
There are at least three ways to contribute to Coral:
- Writing Code
- Providing Translations
Conversation surrounding contributions begins in issues.
File an issue as soon as you have an idea of something you'd like to contribute. We would love to hear what you're thinking and help refine the idea to make it into the Coral ecosystem.
Please file issues if you would like to contribute to Coral.
Coral has adopted an iterative, agile development philosophy. All contributions that make it into the Coral repository should start with a user story in this form:
As a [type of Coral user] I'd like to [do something] so that I can [get some result/value].
This exercise does two things:
- allows us to ground our technical choices in a clear, simple product need.
- expresses that product need in a way that doesn't imply a specific technical solution allowing for debate as to the best way to solve the problem.
Please feel free to provide as much detail as possible when filing the issue but please do keep the initial issue specific to one need and try to avoid including technical or design solutions.
If you have a specific technical or design solution in mind, please submit it as the first comment on the thread.
We use the fluent library and store our
translations in FTL files in
src/locales/ and src/core/server/locales/.
Strings are added or removed from localization bundles in the translation files as needed. Strings MUST NOT be changed after they've been committed and pushed to master. Changing a string requires creating a new ID with a new name (preferably descriptive instead of incremented) and deletion of the obsolete ID. It's often useful to add a comment above the string with info about how and where the string is used.
Once a language has enough coverage, it should be added to
src/core/common/helpers/i18n/locales.ts.