search

artefactual / automation-tools

Tools to aid automation of Archivematica and AtoM.
GNU Affero General Public License v3.0
46 stars 33 forks source link

Dev/contributing #144

Closed eviau-artefactual closed 9 months ago

eviau-artefactual commented 9 months ago

We've noticed that there was no contributing.md file in this repo.

Here is a suggestion that refers to the main AM guidelines.

What do you think?

If this text makes sense to you, I will use it to make other PRs to AM related projects.

eviau-artefactual commented 9 months ago

About linting: if my understanding is correct, the tool used doesn't do the linting for you... is that correct ?

replaceafill commented 9 months ago

About linting: if my understanding is correct, the tool used doesn't do the linting for you... is that correct ?

That's correct. We haven't set up the fix option in markdownlint-cli by default. I'd recommend you to set up pre-commit (pre-commit install) in our repos so it helps you catching linting problems before committing.