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

(#1547) adding contributing guide #1556

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Introduction

Thank you for your interest in contributing to Houdini! This guide aims to facilitate contribution to our project. Follow all the steps below to submit your contribution:

1. Fork the Repository
2. Comment "**WIP**" on the existing Issue or create an issue according to the implemented issue templates.
Abraao1231 marked this conversation as resolved.
Show resolved Hide resolved
3. Create a Branch in Your Fork according to the [Branch Creation Rules](#branch-creation-rules) and make your commits following the [commit creation policies](#commit-policy).

4. After finishing the changes, make a pull request following the [pull request policies](#pull-request-policy).



## Branch Creation Rules

To create branches, use the issue number you're working on, followed by a brief title describing what will be done, as shown in the example below:

```bash
git checkout -b #42/Bug_Fixes_and_Improvements
```

## Commit Policy

To make a commit, follow the format indicated below, using one of the suggested tags:

Available tags for commits:
Abraao1231 marked this conversation as resolved.
Show resolved Hide resolved

* [feature]: For added features.
* [fix]: For bug fixes.
* [refactor]: For code changes that improve structure or readability.
* [docs]: For changes exclusively in the documentation.

Example commit with the [feat] tag:
Abraao1231 marked this conversation as resolved.
Show resolved Hide resolved

```bash
git commit -m "[feat] Add support for OAuth2 authentication"
```

## Pull Request Policy

To create a pull request, follow the defined template below:
```markdown
### Related Issues:
- #Issue_number

### Contributors:
- @Contributor1, @Contributor2

### Description:
Description of what this request will change in the project.

### Changes Made:
_**`Type of change`**_
- Project documentation update.
- Bug fixes.
- Implementation of new features.
```

Thank you for your contribution! We are looking forward to reviewing your PR and incorporating your changes into the project.
Abraao1231 marked this conversation as resolved.
Show resolved Hide resolved