Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

90 lines (63 loc) · 3.29 KB
Raw

Contributing Guidelines

Welcome to the project! We appreciate your interest in contributing. This document will guide you through the process of contributing to our repository. We value the time and effort of our contributors, and we strive to create an inclusive and collaborative community.

Table of Contents

Ways to Contribute

There are several ways to contribute to our project:

  1. Reporting bugs or suggesting enhancements by opening issues.
  2. Fixing issues and submitting pull requests.
  3. Improving documentation.
  4. Providing feedback and suggestions.

Getting Started

To get started with contributing, follow these steps:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Install the required dependencies.
  4. Create a new branch for your changes.
  5. Make your changes and ensure they adhere to the code guidelines.
  6. Commit your changes with descriptive commit messages.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository.

Development Workflow

When working on the project, please follow these guidelines:

  1. Always work on a new branch for each separate issue or feature.
  2. Keep your branch up to date with the main repository's master branch.
  3. Write clear and descriptive commit messages.
  4. Test your changes thoroughly before submitting a pull request.
  5. Keep discussions polite and respectful.

Code Guidelines

  • Follow the existing code style and conventions.
  • Write clear, self-explanatory, and well-documented code.
  • Ensure your code is properly formatted.
  • Write unit tests for your code whenever applicable.

Issue Guidelines

If you encounter a bug, want to suggest an enhancement, or have any other issue:

  1. Search for existing issues before opening a new one.
  2. Provide detailed information about the issue or suggestion.
  3. Include steps to reproduce the problem if it's a bug.
  4. Tag relevant individuals or teams to bring attention to the issue.

Pull Request Guidelines

To submit a pull request:

  1. Make sure your changes are focused and address a single issue or feature.
  2. Provide a clear and descriptive title for your pull request.
  3. Include a summary of the changes and any additional context if necessary.
  4. Reference any related issues or pull requests in your description.
  5. Be responsive to feedback and questions during the review process.

Community Guidelines

We expect all contributors to adhere to the following community guidelines:

  1. Be respectful and considerate towards others.
  2. Use inclusive language and promote a welcoming environment.
  3. Avoid personal attacks, harassment, or discrimination.
  4. Keep discussions on-topic and constructive.
  5. Help others and contribute positively to the community.

Contact

If you have any questions, concerns, or need further assistance, you can reach us at srnightmare09@gmail.com.

We appreciate your interest and contributions to our project. Thank you for helping us make it better!