Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

97 lines (61 loc) · 2.8 KB
Raw

Contributing

The 0xcert Framework is a mono repository with all framework related packages stored in the /packages folder.

Development

We use RushJS to manage this repository. Some quick notes on how to manage the repository are documented here. But here is a quick start to run the test suite if you have just cloned this repository and never used RushJS before. Expect to spend 10 minutes building and running this test suite for the first time. Subsequently testing any code will be faster, and you can limit testing to a specific package.

Install dependencies -- You only need to run this once.

npm install -g @microsoft/rush

Update packages -- Run this if you add/remove packages from this repository.

rush update --full

Rebuild and test -- Do this each time you make changes to the code

rush rebuild --verbose
rush test --verbose

The above notes will help you decide which commands to run during development on your own machine. But for any commits and pull requests in this repository, the entire test suite will be run using continuous integration.

Issues

We use GitHub issues to track bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Pull requests

Always fork the repository and create your branch from master. If you've added code that should be tested, add tests. Also, ensure the test suite passes before submitting the PR.

Coding style

Please follow the TypeScript coding guidelines.

Release process

The release manager will publish packages to NPM using these commands.

NOTE: New packages must be published manually!

$ rush version --bump --override-bump minor
$ rush publish --publish --include-all

0xcert documentation

We are using VuePress for building the documentation pages. Files are built locally from .md files located in /docs folder and generated into a /docs/.vuepress/dist folder.

First, navigate to the root directory and install dependencies.

$ cd ./docs/.vuepress
$ npm i

You can start VuePress in development mode.

$ npm run dev

You can build and deploy the documentation to the server.

$ npm run deploy

0xcert conventions

We are using VuePress for building the conventions pages. Files are built locally from .md files located in /conventions folder and generated into a /convntions/.vuepress/dist folder.

First, navigate to the root directory and install dependencies.

$ cd ./conventions/.vuepress
$ npm i

You can start VuePress in development mode.

$ npm run dev

You can build and deploy the conventions to the server.

$ npm run deploy