Hi 👋 🦄.
Make sure you have latest yarn installed locally. To get started with the repo, after cloning the repo.
yarn installDocumentations resides in the docs folder. The content will be published to the official website. As a user of the library and tools, you are the best person for writing them. Any help with documentation would be appreciated greatly.
It’s often a good idea to create an issue to discuss the bug or feature before creating a pull request to prevent from doing unnecessary work.
Have some cool ideas? Let’s talk about it in the Discussions tab.
We are following the conventional commits standards, an example would be:
feat(parser): add new syntax this is a body
The above commit message would result in a minor version bump when it is merged into master for release. Take a look at the spec for more details. This is for extracting changelog and streamline version bump automatically.
yarn build # always build before running tests
yarn testPlease submit pull requests against develop branch. master is for releasing.
All packages in orgajs is automatically released once merged into master. That’s why the commit message is extra important. Especially when there are BRAKING CHANGE.