Any type of contribution to the project is also welcome! I use the GitHub issues as a todo list, so if you want to help, read existing issues. Or, if you want to add something new, write new issues with your ideas, and we will discuss it.
To develop Chronoblog, you need to have Nodejs version 15 or higher, and npm version 7 or higher. To use Chronoblog, it is enough to have version 12 of Nodejs, but this repository is a monorepository - and it is made on the basis of npm workspaces.
Contributions to the README are welcome, especially considering that English is not my native language.
However, remember that you need to edit this README: https://github.com/Chronoblog/gatsby-theme-chronoblog/blob/master/packages/gatsby-theme-chronoblog/README.md - this one located in packages/gatsby-theme-chronoblog/README.md is "real".
At the moment I am working to ensure that the development process here is consistent with GitHub flow
Every time there is a new push to any branch, a .github/workflows/new-push.yml will be launched. It will run tests and run builds in various environments to check if they build correctly.
Publishing a new version is publishing a new version in npm and publishing new versions of starters in their repositories. This process is due to .github/workflows/new-push.yml.
Every time a push comes to the master, the following happens:
- tests
- check if the version of the package for npm has been updated, and if so, the new version is sent to npm.
- copying content for starters to separate repositories of these starters
This monorepo uses npm workspaces.
- packages folder. At the moment there is only gatsby-theme-chronoblog/tree/master/packages/gatsby-theme-chronoblog there, and all the main work on the project takes place in it. Perhaps in the future, additional packages will appear.
If you looked at the package.json file in the root of the project, then you saw TypeScript and types for various libraries in the dependencies (@types/node, @types/react, etc.). But the project is written in js?
The fact is that JSDoc comments are used to declare types. Read more about this method in these articles: