Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add precommit script to lint the README file #60

Open
rogerluan opened this issue Jun 30, 2020 · 2 comments
Open

Add precommit script to lint the README file #60

rogerluan opened this issue Jun 30, 2020 · 2 comments

Comments

@rogerluan
Copy link
Contributor

Lint the file with things such as:

  • Removing trailing whitespace
  • Auto-executing the progress.sh file

Caveat: precommit hooks don't work if people are modifying the README via GitHub's website 😞

Open to discuss

@Blackjacx
Copy link
Owner

Blackjacx commented Jun 30, 2020

I like it, it's okay when the progress is not always correct. Every new submission via local git will fix it 👍 Also my little refactoring will fix it #57 (comment). With this we won't need point 2 at all.

@rogerluan
Copy link
Contributor Author

You're right! I think it's more clever to do this in the CI, and leave precommit only for linting 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants