Contribution Guide

How to Start contributing

Welcome! We are delighted that you want to contribute to our project! 💖

This project accepts contributions via GitHub pull requests.

This document outlines the process to help ensure your contribution is accepted.

There are several ways to contribute:

Here's a quick guide:

Create your fork of the repository.
Clone the project to your machine.
To keep track of the original repository add another remote named "upstream".
```
git remote add upstream git@github.com:dbelyaev/action-checkstyle.git
```
Create a branch locally with a succinct but descriptive name, prefixed with change type.
```
git checkout -b feature/my-new-feature
```
Make the changes in the created branch.
Add the changed files.
```
git add path/to/filename
```
Commit your changes using the conventional commits formatting for the commit messages.
```
git commit -m "conventional commit formatted message"
```
Before sending the pull request, make sure to rebase onto the upstream source. This ensures your code is based on the latest available code.
```
git fetch upstream
git rebase upstream/main
```
Push to your fork.
```
git push origin feature/my-new-feature
```
Submit a pull request to the original repository via GitHub interface.
- Please provide us with some explanation of why you made the changes you made.
- For new features make sure to explain a standard use case to us.

That's it... thank you for your contribution!

After your pull request is merged, you can safely delete your branch.

The core team regularly reviews pull requests.

After feedback has been provided, we expect responses within three weeks.

If there is no activity on the pull request after three weeks, we may consider closing it.