File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed
Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -31,6 +31,41 @@ git commit --signoff
3131Only pull requests from committers that can be verified as having signed the OCA
3232can be accepted.
3333
34+ ## Getting Started
35+
36+ 1 . Open a terminal window
37+ 2 . Clone the repository
38+ 3 . Change into the cloned repository directory
39+ 4 . Install dependencies by running
40+
41+ ``` bash
42+ npm install
43+ ```
44+
45+ # # Building Locally
46+
47+ Once you have set up the project, you can build the library by executing:
48+
49+ ` ` ` bash
50+ npm run build
51+ ` ` `
52+
53+ # # Running Tests
54+
55+ Once you have set up the project, you can run the test suite by executing:
56+
57+ ` ` ` bash
58+ npm run test
59+ ` ` `
60+
61+ # # Running the Example CLI
62+
63+ Once you have built the library, you can run the example CLI by executing:
64+
65+ ` ` ` bash
66+ npm run example-cli
67+ ` ` `
68+
3469# # Pull request process
3570
36711. Ensure there is an issue created to track and discuss the fix or enhancement
You can’t perform that action at this time.
0 commit comments