Skip to content

Commit aaaab76

Browse files
committed
Added Contributions section to the README.
1 parent 20c5f8d commit aaaab76

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,34 @@ and the data provided while the AST is presented.
186186
- Definition lists are not supported
187187
- The following text features may be tweaked: font, size, spacing, style, fill colour, and text colour. These are exported and available via the `Styler` struct. Note that fill colour only works when using `CellFormat()`. This is the case for tables, code blocks, and backticked text.
188188
189+
## Contributions
190+
191+
- Set up and run pre-commit hooks:
192+
193+
```sh
194+
# Install the needed GO packages:
195+
go install github.com/go-critic/go-critic/cmd/gocritic@latest
196+
go install golang.org/x/tools/cmd/goimports@latest
197+
go install golang.org/x/lint/golint@latest
198+
go install github.com/gordonklaus/ineffassign@latest
199+
200+
# Install the `pre-commit` util:
201+
pip install pre-commit
202+
203+
# Generate `.git/hooks/pre-commit`:
204+
pre-commit install
205+
```
206+
207+
Following that, these tests will run every time you invoke `git commit`:
208+
```sh
209+
go fmt...................................................................Passed
210+
go imports...............................................................Passed
211+
go vet...................................................................Passed
212+
go lint..................................................................Passed
213+
go-critic................................................................Passed
214+
```
215+
216+
- Submit a pull request and include a succinct description of the feature or issue it addresses
189217
190218
[license]: ./LICENSE
191219
[badge-license]: https://img.shields.io/github/license/solworktech/mdtopdf.svg

0 commit comments

Comments
 (0)