Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 3.27 KB
Raw

Contributing Guidelines

Welcome to the project! We appreciate your interest in contributing. Before getting started, please take a moment to review these guidelines. They will help ensure a smooth and collaborative development process.

Table of Contents

Getting Started

To start contributing to this project, follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b feature/your-feature.
  4. Make your desired changes or additions.
  5. Test your changes thoroughly.
  6. Commit your changes: git commit -m "Add your commit message here".
  7. Push your changes to your forked repository: git push origin feature/your-feature.
  8. Open a pull request in this repository and provide a clear description of your changes.

Submitting Contributions

When submitting your contributions, please keep the following in mind:

  • Make sure your code is well-documented, easy to understand, and follows the project's coding guidelines.
  • Include relevant tests with your code and ensure that all tests pass.
  • Provide a clear and descriptive title for your pull request.
  • Describe the purpose of your changes and any relevant details in the pull request description.
  • Respond to any feedback or code review comments promptly.

Coding Guidelines

  • Follow the existing code style and conventions used in the project.
  • Maintain consistency with the surrounding code.
  • Write clear and concise code that is easy to understand.
  • Document your code adequately to explain its purpose and functionality.
  • Comment your code when necessary, especially for complex logic or non-obvious behavior.

Commit Guidelines

  • Use descriptive and meaningful commit messages.
  • Separate the subject from the body with a blank line.
  • Start the subject line with a verb in the imperative form (e.g., "Add," "Fix," "Update").
  • Limit the subject line to 50 characters and wrap the body at 72 characters.
  • Reference any relevant issues or pull requests in the commit message body using the appropriate keywords (e.g., "Fixes #123").

Issue Guidelines

If you encounter a bug, have a feature request, or need assistance, please open an issue in the repository's issue tracker. When creating an issue, include the following information:

  • A clear and descriptive title.
  • Detailed steps to reproduce the issue (if applicable).
  • Information about your environment (operating system, relevant software versions).
  • Any additional context or relevant information.

Community Guidelines

We value an inclusive and welcoming community. Therefore, we ask that you:

  • Be respectful and considerate towards others.
  • Refrain from any offensive, discriminatory, or harassing behavior.
  • Encourage and support fellow contributors.
  • Engage in constructive and meaningful discussions.
  • Follow the project's code of conduct.

Thank you for contributing to the project!