Skip to content

Commit

Permalink
add pre-commit installation and running ar CONTRIBUTING.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
nadasuhailAyesh12 committed Mar 23, 2024
1 parent 8718842 commit 8561fd9
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,30 @@ Thank you for considering contributing to htmldate!

Here are some important resources:

* [List of currently open issues](https://github.com/adbar/htmldate/issues) (no pretention to exhaustivity!)
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [List of currently open issues](https://github.com/adbar/htmldate/issues) (no pretention to exhaustivity!)
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

There are many ways to contribute, you could:

* Improve the documentation
* Find bugs and submit bug reports
* Submit feature requests
* Write tutorials or blog posts
* Write code
- Improve the documentation
- Find bugs and submit bug reports
- Submit feature requests
- Write tutorials or blog posts
- Write code

## Installing and Running Pre-commit

### Introduction

Pre-commit is a tool that helps maintain a consistent code style and quality in our project by running a set of hooks before each commit. These hooks perform checks such as code formatting, linting, and ensuring compliance with project-specific guidelines.

### Installation and Running

To install and set up pre-commit in your development environment, follow these steps:

1. **Install Pre-commit**: Run `pip install pre-commit` to your terminal to install pre-commit using pip.
2. **Install the git hook scripts**: Once pre-commit is installed, navigate to your project directory and run `pre-commit install`to initialize pre-commit hooks.
3. **(optional) Run against all the files**: After pre-commit is installed and initialized, you can run it manually on your changes using `pre-commit run --all-files`

## Submitting changes

Expand All @@ -23,7 +37,6 @@ Please send a [GitHub Pull Request to htmldate](https://github.com/adbar/htmldat

For further questions you can contact me on [GitHub issues](), [Twitter](https://twitter.com/adbarbaresi) or by [E-Mail](http://adrien.barbaresi.eu/contact.html)


Thanks,

Adrien
Adrien

0 comments on commit 8561fd9

Please sign in to comment.