Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.24 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We appreciate your time and effort in making this project better.

Code of Conduct

Please note that by contributing to this project, you are expected to adhere to our Code of Conduct. Make sure to familiarize yourself with its guidelines and ensure your contributions align with them.

Making Changes

Before you start making changes, please ensure you have reviewed the project's documentation and code of conduct. Here are some guidelines to follow:

  • Follow the style and coding conventions used in the project.
  • Write clear and concise commit messages.
  • Include tests for any new features or bug fixes.
  • Ensure all tests pass before submitting your changes.
  • Update any documentation that is impacted by your changes.
  • make sure to disclose any third party source code or libraries used in your project.

Getting Started Internal Contributors

To get started with contributing, please follow these steps:

  1. Clone the repository to your local machine.
  2. Create a new branch for your contributions.
  3. Make your changes and commit them with a descriptive message.
  4. Push your changes to the remote repository.

Getting Started External Contributors

To get started with contributing, please follow these steps:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contributions.

Submitting a Pull Request

Once you have made your changes and are ready to submit them, follow these steps:

  1. Commit your changes with a descriptive message.
  2. Push your changes to your forked repository.
  3. Open a pull request against the main branch of the original repository.
  4. Provide a clear title and description for your pull request, explaining the changes you have made.

Code Review

Your pull request may be reviewed by one or more project maintainers. They may provide feedback, request changes, or ask for additional information. Please be responsive and address any feedback promptly.

Help and Support

There is no specific help or support for this project. If you need any help or have questions, feel free to reach out to us through [email or other communication channel].

Happy contributing!