Mikaela
/
.github
mirror of https://github.com/Mikaela/.github.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

CONTRIBUTING.md: note pre-commit

This commit is contained in:
Aminda Suomalainen 2023-02-22 10:35:48 +02:00
parent 44f7d66a48
commit 1c4dc6b930
Signed by: Mikaela
SSH Key Fingerprint: SHA256:CXLULpqNBdUKB6E6fLA1b/4SzG0HvKD19PbIePU175Q
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -1,11 +1,8 @@
# Contributing
Contributions are welcomed assuming my repositories are the correct place
for it (the target is my repository or a PR I have open to another repository).
In case [editorconfig](https://editorconfig.org/) isn't
[natively supported by your editor of choice](https://editorconfig.org/#pre-installed),
please consider [installing a plugin](https://editorconfig.org/#download).
E.g. VS Cod{e,ium} users can `CTRL-P` and execute `ext install EditorConfig.EditorConfig`.
Issues being assigned to me doesn't matter, I use that just as a tool for
rediscovering them easily, http://github.com/issues?q=is:open%20assignee:Mikaela
@ -13,3 +10,13 @@ I also accept PRs to repositories that are mirrors (if that is easier for you
than opening at the original location) as patches are easy enough to export
from GitHub or `git remote`s to use, the merge might just take a bit longer
(including the time the mirror takes to update).
## General steps
1. In case [editorconfig](https://editorconfig.org/) isn't
[natively supported by your editor of choice](https://editorconfig.org/#pre-installed),
please consider [installing a plugin](https://editorconfig.org/#download).
E.g. VS Cod{e,ium} users can `CTRL-P` and execute `ext install EditorConfig.EditorConfig`.
2. If the repository in question has a `.pre-commit-config.yaml` file,
please install [`pre-commit`](https://pre-commit.com/) and run
`pre-commit install` in your local clone at least once.