First off, thank you for considering contributing to Kratos. It's people like you that make the future of Kratos brighter.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
There are many ways to contribute, from writing blog posts (tutorials) or making video content, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Kratos itself.
- Variables should be in
camelCase. - Functions should be in
camelCase(). - Object keys should be in
snake_case: value - File names should be in
camelCase.jsexcept classes but you're not allowed to create new classes without discussing it with core team first.
- Ensure code follows above listed style-guide
- Make sure to KISS
- Make sure to follow StackOverflow's API design best practices
- Make sure code is bug free and properly tested.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
Steps required:
- Create your own fork of the code
- Do the changes in your fork
- follow style guide and read responsibilities above
- Test the code by creating a test project and linking to it (Package name is: @kratosbase/kratos).
- If code works and is bug-free, submit a PR
Beginner Note: If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
The Kratos philosophy is to provide a system for deploying web APIs as quickly as possible and is largely opinionated. To ensure a high quality and scalable system, a lot of patterns have to be forced like how resources should be routed and consumed.
If you find yourself wishing for a feature that doesn't exist in Kratos, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Kratos has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
As long as your code follows the style guide and you carry out your responsibilities as a contributor, your PR will be accepted and merged so long as there are no conflicts.
In the case of conflicts, you might need to rebase or otherwise you should be provided support on how to fix these conflicts.
Happy contributing ✌🏿