Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

86 lines (60 loc) · 3.58 KB

Contribution Guidelines

Thank you for considering contributing to our project! We welcome contributions from the community and appreciate your efforts to improve the project. Please take a moment to review these guidelines before you get started.

Table of Contents

How to Contribute

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Submit a pull request.

Code of Conduct

Please adhere to our Code of Conduct in all interactions with the project.

Reporting Issues

If you find a bug or have a feature request, please open an issue. Before doing so, please search the existing issues to see if your issue has already been reported.

  1. Go to the Issues section.
  2. Check if the issue already exists.
  3. If not, create a new issue using the provided template.

Issue Template

When creating a new issue, please include the following information:

  • Title: A descriptive title for the issue.
  • Description: A detailed description of the issue or feature request.
  • Steps to Reproduce: If applicable, provide the steps to reproduce the issue.
  • Expected Behavior: Describe what you expected to happen.
  • Actual Behavior: Describe what actually happened.
  • Screenshots: If applicable, include screenshots to help illustrate the issue.
  • Environment: Provide information about your environment, such as operating system, browser, and version of the project.

Submitting Pull Requests

We appreciate your pull requests! To help us review and merge your changes, please follow these guidelines:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
  2. Create a Branch: Use a descriptive name for your branch, such as feature/add-new-feature or bugfix/fix-issue.
  3. Make Changes: Implement your changes in your branch.
  4. Commit Changes: Write clear and concise commit messages. Follow the Commit Messages guidelines below.
  5. Push to GitHub: Push your changes to your forked repository.
  6. Open a Pull Request: Go to the original repository and click on the "New Pull Request" button. Provide a detailed description of your changes and any relevant information.

Pull Request Template

When submitting a pull request, please include the following information:

  • Title: A descriptive title for the pull request.
  • Description: A detailed description of the changes you have made.
  • Related Issues: If applicable, reference related issues by number.
  • Screenshots: If applicable, include screenshots to help illustrate your changes.
  • Checklist: Ensure your pull request adheres to the following checklist:
    • Code follows the project’s coding standards.
    • Tests have been added or updated.
    • Documentation has been updated (if applicable).

Commit Messages

Write clear and concise commit messages to describe your changes. Use the following format:

  • Title: A short summary of the changes (50 characters or less).
  • Body (optional): A detailed description of the changes. Use bullet points for clarity.

Example:

Add new feature for user authentication

- Implement login functionality
- Add tests for authentication
- Update documentation with usage instructions