Overview
Contribution
Blok is an open-source project built to redefine how developers architect and deploy scalable applications. Whether you’re passionate about optimizing workflows, building reusable nodes, or improving developer experience, your contributions can make a real impact! Help us shape the future of modular cloud development by submitting nodes, addining more functionality, improving documentation, or sharing feedback. Every contribution—big or small—pushes the project forward. Jump in, collaborate, and let’s build something amazing together! 💡🔧
How to Contribute
1
First Step
Fork & Clone the repository.
2
Second Step
Make changes based on the project roadmap or propose the changes there.
3
Third Step
Create tests and make sure you have 100% coverage.
4
Forth Step
Submit a Pull Request with a clear description following the provided template.
Setting up the Development Environment
To set up the development environment, follow the steps below:1
Close the repository
2
Install the dependencies
The following command will install the dependencies required for the project.
3
Create env
The following command will create the
.env.local required by the tests in the runner project.Before committing your changes
1
Run build process
The following command will will create the build for all the projects because as required by monorepo.
2
Generate documentation
If you’ve made any changes to the
/core of the project, make sure you you run the following command to update the TypeDoc documentation.
The following command will install the dependencies required for the project.3
Run test
The following command will execute the test in all the projects
Best Practices
1
First Step
Follow TypeScript standards for consistency.
2
Second Step
Keep in mind the objectives of the project
3
Third Step
Document your code and make adjustments to the
/docs section if your changes affect the public use of the framework.