Skip to content

Commit

Permalink
chore(bors): merge pull request #321
Browse files Browse the repository at this point in the history
321: docs: fix contributing guide r=tiagolobocastro a=tiagolobocastro

<!

Co-authored-by: Tiago Castro <[email protected]>
  • Loading branch information
mayastor-bors and tiagolobocastro committed Aug 22, 2023
2 parents f49fa82 + 963724c commit b2bf668
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ If you have any questions, our ecosystem can be connected with over [Slack][maya

Our interactions here are governed by the [CNCF Code of Conduct](CODE-OF_CONDUCT.md).

## Development Environment

Consult the [`doc/build.md`](doc/build.md) for a complete guide to getting started contributing
to Mayastor.

## Issues & Pull Requests

### Reporting Bugs
Expand Down Expand Up @@ -55,7 +50,7 @@ Once review is given, Maintainers and SIG members may indicate merge readiness w
**Please do not hit the 'Update Branch' button.** The commit message is not conventional,
[bors][bors] will yell at you. Let [bors][bors] handle it, or rebase it yourself.

### Development
### Development Environment

This repo, much like most of the mayastor-specific repos makes use of nix.

Expand Down Expand Up @@ -107,7 +102,9 @@ If you're only modifying the helm chart we recomment you enter nix-shell from th
>
> That's totally fine, just make sure you have `helm-docs` installed and run the docs script
> ```bash
> [@dev:~/git/mayastor/extensions]$ ./scripts/helm/> generate-readme.sh
> [@dev:~/git/mayastor/extensions]$ ./scripts/helm/generate-readme.sh
> INFO[2023-08-22T08:55:06+01:00] Found Chart directories [chart]
> INFO[2023-08-22T08:55:06+01:00] Generating README Documentation for chart chart
> ```
[mayastor-slack]: https://kubernetes.slack.com/messages/openebs
Expand Down

0 comments on commit b2bf668

Please sign in to comment.