Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.4 KB
Raw

Contributing

Thank you for wanting to contribute to this project! Please follow the guidelines below to ensure that your contributions are well integrated.

Commit Patterns

This project follows the Conventional Commits commit patterns. Please use the following commit types in your posts:

  • feat: Adds new functionality to the project.
  • fix: Fixes a bug or identified issue.
  • docs: Updates the documentation (README, guides, etc.).
  • style: Formatting changes, such as spaces, commas, etc., without changing the code logic.
  • refactor: Refactors the code without changing functionality or fixing bugs.
  • test: Adds tests or refactors existing tests, without changing the production code. - chore: Task or maintenance updates that do not affect production code (e.g., configurations, packages).

Commit Message Examples

  • feat: add form validation to add_pet page
  • fix: correct error handling in pet insertion
  • docs: update README with new demo link
  • style: adjust spacing and layout in index.html

How to Contribute with Pull Requests

  1. Fork the Repository: Create a copy of the repository on your GitHub account.

  2. Create a New Branch for Your Contribution:

Choose a descriptive name for the branch, according to the functionality or fix you are implementing:

git checkout -b feature/your-feature-name
  1. Make Changes and Commit:

Make the changes and use a commit message following the mentioned standards:

git commit -m 'feat: clear description of the change'
  1. Push Your Changes to GitHub:

Upload the branch with your changes to your fork:

git push origin feature/your-feature-name
  1. Open a Pull Request:

On GitHub, go to the original repository and click "Compare & pull request". Describe your changes and submit the PR for review.

Review and Approval

  • Make sure your code is aligned with the project style and standards.
  • Include details about the changes made in your Pull Request.
  • Wait for feedback and be open to suggested adjustments during review.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as this repository, ensuring that all contributors and users can benefit from your efforts.

Thank you for your contributions to the growth and improvement of this project!