Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

90 lines (62 loc) · 3.16 KB

Contributing to ⚡️zig-bpe

Thank you for your interest in contributing to ⚡️ zig-bpe! We welcome contributions from the community and appreciate your help in making our project better.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with a clear commit message.
  5. Push your changes to your fork on GitHub.
  6. Submit a pull request to the main repository.

For more detailed instructions, please refer to the GitHub guide on contributing to projects.

How to Contribute

There are many ways to contribute to this project:

  • Code contributions
  • Documentation improvements
  • Bug reports
  • Feature suggestions
  • Answering questions and providing support
  • Improving tests

Remember, contributions don't have to be code-related. Non-code contributions are equally valuable!

Reporting Bugs

If you find a bug, please open an issue on our GitHub repository. When reporting a bug, please include:

  • A clear and descriptive title
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any relevant screenshots or error messages

Suggesting Enhancements

We welcome suggestions for enhancements. Please open an issue on our GitHub repository and include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • Any potential implementation details (if applicable)
  • Why you believe this enhancement would be valuable

Pull Request Process

  1. Ensure your code adheres to our style guidelines.
  2. Update the README.md with details of changes, if applicable.
  3. Add tests for your changes if possible.
  4. Ensure all tests pass.
  5. Make sure your code is properly documented.
  6. Issue the pull request with a clear title and description.

Style Guidelines

[Include any specific coding style guidelines for your project here]

Community

Join our community! Here are some ways to get involved:

  • Join our [Discord/Slack/Mailing List]
  • Attend our community meetings (if applicable)
  • Follow us on [Twitter/LinkedIn/etc.]

Remember, open source is about collaboration and community. Don't be afraid to ask questions or seek help. We're all here to learn and grow together!

For more inspiration on contributing to open source, check out this guide on making your first open source contribution.

Thank you for contributing to [Project Name]!