@bbc/morty-docs 1.8.0 → 1.8.1
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 +28 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -88,17 +88,12 @@ through because it is not markdown or asciidoc e.g. images
|
|
|
88
88
|
|
|
89
89
|
## Things to Consider
|
|
90
90
|
|
|
91
|
-
### File Ordering
|
|
91
|
+
### File & Directory Ordering
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
These are sorted lexically (0-9 < a-z>).
|
|
94
94
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
## Releasing
|
|
98
|
-
|
|
99
|
-
Releases are versioned through `npm version`, and publishing is handled by our [Travis CI Integration](./.travis.yml)
|
|
100
|
-
|
|
101
|
-
`$ npm version (major|minor|patch)`
|
|
95
|
+
There is an additional sort.
|
|
96
|
+
If you want your documents to be sorted reverse chronologically, use the date as a prefix to the file name in the format YYYY-MM-DD e.g. `19-11-2019-some-document`. These will then be placed first above the regular sort.
|
|
102
97
|
|
|
103
98
|
## Example Architecture
|
|
104
99
|
|
|
@@ -134,6 +129,29 @@ We welcome contributions from everyone.
|
|
|
134
129
|
|
|
135
130
|
Please respect each other.
|
|
136
131
|
|
|
132
|
+
## How to contribute
|
|
133
|
+
|
|
134
|
+
Steps:
|
|
135
|
+
|
|
136
|
+
- fork the repo
|
|
137
|
+
- implement your fix or feature - with test coverage :-)
|
|
138
|
+
- raise a [PR](https://github.com/bbc/morty-docs/pulls)
|
|
139
|
+
- this repo now uses github actions for automated Pull Request checking & Publishing
|
|
140
|
+
- n.b. first-time contributors require approval to run github actions
|
|
141
|
+
(so your PR checker should fail to run initially)
|
|
142
|
+
- use ['Pull Request Checks' github action](https://github.com/bbc/morty-docs/actions/workflows/pull-requests.yml) to
|
|
143
|
+
see if the PR checker is passing
|
|
144
|
+
|
|
145
|
+
### Maintainers only
|
|
146
|
+
|
|
147
|
+
- merge PR (or suggest changes)
|
|
148
|
+
- after merge
|
|
149
|
+
- use `npm version (major|minor|patch)`
|
|
150
|
+
- the tag created above causes
|
|
151
|
+
['Node.js Package' github action](https://github.com/bbc/morty-docs/actions/workflows/npm-publish.yml) to run.
|
|
152
|
+
Wait for this to complete.
|
|
153
|
+
- verify the new version on [NPM](https://www.npmjs.com/package/@bbc/morty-docs)
|
|
154
|
+
|
|
137
155
|
### Adding an issue
|
|
138
156
|
|
|
139
157
|
If you spot an issue or just want to raise one please use the issue template.
|
|
@@ -171,4 +189,4 @@ We would expect code quality to be at least as good if not better than
|
|
|
171
189
|
the code quality of the project at the time you make your contribution.
|
|
172
190
|
After all, we all hope to leave things better than we find them!
|
|
173
191
|
|
|
174
|
-
© BBC
|
|
192
|
+
© BBC 2021
|
package/package.json
CHANGED