@jphil/bookwhen-client 0.0.8 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -59
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,65 +52,7 @@ API keys can be generated in the [API tokens setup area of your Bookwhen account
|
|
|
52
52
|
|
|
53
53
|
## Contributing
|
|
54
54
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
Thank you for your interest in contributing!
|
|
58
|
-
|
|
59
|
-
This library follows the standard Github Flow contribution workflow, have a read of the guide to [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow#following-github-flow) from the Github docs, if you're not familiar.
|
|
60
|
-
|
|
61
|
-
### Contribution Requirements
|
|
62
|
-
|
|
63
|
-
- Use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style when writing your commit messages.
|
|
64
|
-
- Ensure you create a [changeset](https://github.com/changesets/changesets) as the final commit before creating a new PR (or updating one).
|
|
65
|
-
|
|
66
|
-
#### Setting Up Husky for Contributions
|
|
67
|
-
|
|
68
|
-
This project uses Husky for Git hooks and Commitlint to enforce commit message standards.
|
|
69
|
-
|
|
70
|
-
Install Dependencies: First, clone the repository and install the project dependencies, which include Husky:
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
git clone <repository-url>
|
|
74
|
-
cd <repository-directory>
|
|
75
|
-
pnpm install
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Activate Husky Hooks: After installing dependencies, you need to initialize Husky's Git hooks. Run the following command:
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
pnpm husky install
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
This command sets up a .husky/ directory in the project, linking the necessary scripts to Git’s hook system. Once activated, Husky will automatically enforce commit message standards during commits.
|
|
85
|
-
|
|
86
|
-
Thank you for helping maintain commit quality and consistency!
|
|
87
|
-
|
|
88
|
-
\[wip\]!
|
|
89
|
-
|
|
90
|
-
## CI
|
|
91
|
-
|
|
92
|
-
>>> consider changesets in the following?
|
|
93
|
-
|
|
94
|
-
### Contrib flow
|
|
95
|
-
|
|
96
|
-
- Contrib user clones repo locally
|
|
97
|
-
- Contrib user creates a feature branch
|
|
98
|
-
- Contrib user generates commits to feature branch
|
|
99
|
-
- Contrib user create a PR back to the origin/[default branch]
|
|
100
|
-
- CI pipeline activates and runs at least tests && build
|
|
101
|
-
-> On success PR can be merged to main by Maintainer
|
|
102
|
-
-> On fail PR needs updating until tests and build success
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
### Maintainer flow
|
|
106
|
-
|
|
107
|
-
- Maintainer decides that code on main is ready to release
|
|
108
|
-
- Mt pulls main
|
|
109
|
-
- Mt checks out new "release" branch
|
|
110
|
-
- Mt runs: pnpm changeset add
|
|
111
|
-
- Mt commits results when happy with the change set
|
|
112
|
-
- Mt run changeset version
|
|
113
|
-
[WIP]
|
|
55
|
+
Please see the docs in the CONTRIBUTIONS.md file, thanks!
|
|
114
56
|
|
|
115
57
|
## Roadmap
|
|
116
58
|
|