You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ A few macros and environment variables control certain aspects of the build:
116
116
117
117
These can be set either as environment variables or directly on the `rake` command line.
118
118
119
-
Setting `SIGNING_KEY_PEM` creates file `$HOME/.gem/signing_key.pem` and sets `SIGNING_KEY`.
119
+
Setting `SIGNING_KEY_PEM` creates file `$HOME/.gem/signing_key.pem` and sets `SIGNING_KEY` to that path.
120
120
121
121
> [!NOTE]
122
122
> Environment variables `ASPERA_CLI_*` are typically set in the user’s shell profile for development.
@@ -153,6 +153,12 @@ To check URLs during documentation generation, set the environment variable: `AS
153
153
154
154
To debug documentation generation, set the environment variable: `ASPERA_CLI_DOC_DEBUG=debug`.
155
155
156
+
To generate documentation:
157
+
158
+
```bash
159
+
rake doc:build
160
+
```
161
+
156
162
## Test Environment
157
163
158
164
Refer to <tests/README.md>.
@@ -192,7 +198,7 @@ Update with:
192
198
bundle exec rake tools:grpc
193
199
```
194
200
195
-
It downloads the latest `proto` file and then compiles it.
201
+
It downloads the latest `proto` file and then compiles it into ruby sources included in the repo.
196
202
197
203
## Container image build
198
204
@@ -212,7 +218,8 @@ bundle exec rake -T ^binary:
212
218
213
219
### Branching Strategy
214
220
215
-
This project uses a single `main` branch for development. During the development cycle, the version in `lib/aspera/cli/version.rb` uses a `.pre` suffix (e.g., `x.y.z.pre`) to indicate a pre-release state.
221
+
This project uses a single `main` branch for development.
222
+
During the development cycle, the version in `lib/aspera/cli/version.rb` uses a `.pre` suffix (e.g., `x.y.z.pre`) to indicate a pre-release state.
216
223
217
224
Feature development and bug fixes can be done either:
0 commit comments