Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.73 KB

Contributing

Thank you for your interest in contributing to this project! We appreciate any contributions that help improve the project and make it even better. To ensure a smooth and collaborative development process, please follow these guidelines when contributing.

Opening an Issue

Before starting to work on a new feature or bug fix, it is recommended to create an issue on the GitHub repository. This allows for discussion and ensures that your contribution aligns with the project's goals.

Opening a Pull Request

To contribute your changes, please follow these steps:

  1. Create a new branch from the main branch of your local repository or create branch directly from the issue.
  2. Make your changes and commit them following the conventional commit format.
  3. Provide a descriptive title and a detailed description of your changes in the pull request.
  4. Submit the pull request.

Conventional Commits

Conventional Commits

We follow the conventional commits specification (https://www.conventionalcommits.org/) for our commit messages. Please ensure that your commit messages adhere to this format. This convention helps maintain a standardized and readable commit history. A conventional commit message should have the following format:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Here's an example of a valid commit message:

feat(api): add user authentication endpoint

- Implement the user authentication endpoint.
- Add tests for the new endpoint.
- Update documentation.

Licence

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for your contribution! Your time and effort are greatly appreciated.