Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.28 KB
Raw

Certainly! Here's a template for contribution guidelines:

Contribution Guidelines

Thank you for considering contributing to Cloudflare-R2! We welcome your contributions to improve and enhance our project. Please take a moment to review the following guidelines.

Code of Conduct

Before you start contributing, please read and adhere to our Code of Conduct. We strive to maintain a positive and inclusive community.

Ways to Contribute

There are several ways you can contribute to Cloudflare-R2:

  1. Bug Reports: If you encounter a bug, please submit a detailed issue report. Include information about your environment, steps to reproduce the issue, and any relevant details.

  2. Feature Requests: Suggest new features or improvements. Provide a clear description of the proposed enhancement and why it would be valuable.

  3. Pull Requests: If you'd like to fix a bug or contribute a new feature, submit a pull request. Follow our template and guidelines to ensure a smooth review process.

  4. Documentation: Help improve our documentation. Whether it's fixing a typo or adding more detailed explanations, every improvement is valuable.

Getting Started

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Install dependencies by following the instructions in the project's documentation.
  4. Create a new branch for your contribution (git checkout -b feature/your-feature).
  5. Make your changes and test thoroughly.
  6. Commit your changes (git commit -m 'Add some feature').
  7. Push to the branch (git push origin feature/your-feature).
  8. Open a pull request with a clear title and description.

Code Guidelines

  • Follow the coding style and conventions outlined in the project.
  • Write clear and concise commit messages.
  • Keep code changes focused on a specific issue or feature.
  • Ensure your code is properly tested.

Code Review

All contributions will go through a code review process. Be open to feedback and be prepared to make changes to your code if necessary.

Licensing

By contributing, you agree that your contributions will be licensed under the project's license.

Thank you for your contributions!