Contributing

We follow a code of conduct when participating in the community. Please read it before you make any contributions.

• If you plan to work on an issue, mention so in the issue page before you start working on it.
• If you plan to work on a new feature, create an issue and discuss it with other community members/maintainers.
• Ask for help in our community.

Ways to contribute

• Stars on GitHub: If you're a Linen user and enjoy using our platform, don't forget to star it on GitHub! 🌟
• Improve documentation: Good documentation is imperative to the success of any project. You can make our documents the best they need to be by improving their quality or adding new ones.
• Give feedback: We are constantly looking for feedback. Please share how you use Linen, what painpoints you have or things that bother you with other tools. If you have the time or capacity schedule a call with Kam to talk about painpoints/past experience with other tools. We are constantly in the look out for high quality long form feedback or insights based on your experience.Linen community.
• Share Linen: Help us reach people. Share Linen repository and blog posts with everyone who can be interested.
• Contribute to codebase: your help is needed to make this project the best it can be! You could develop new features or fix existing issues - every contribution will be welcomed with great pleasure!

Commit convention

Linen is a monorepo. For a monorepo, commit messages are essential to keep everything clear. We use conventional commits to keep our commit messages consistent and easy to understand.

<type>(optional scope): <description>

Examples:

• feat: allow provided config object to extend other configs
• fix: array parsing issue when multiple spaces were contained in string
• docs: correct spelling of CHANGELOG

Running in development mode

• Getting Started

Please make sure you contribute well tested code.