Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.62 KB

Contributing to Peanut

Thank you for considering contributing to Peanut! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.
  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
  • A descriptive title and summary.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.

Suggesting Enhancements

  1. Check if the enhancement was already suggested by searching on GitHub under Issues.
  2. If not, open a new issue and provide:
  • A clear and descriptive title and summary.
  • A detailed description of the proposed enhancement.
  • Any relevant examples or use cases.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch from main for your feature or bugfix.
  3. Make your changes.
  4. Ensure your code follows the project's coding standards.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request against the main branch of the original repository.

Code Style

  • Follow the coding style used in the project.
  • Write clear, concise, and meaningful commit messages.

Code of Conduct

Please read and follow our Code of Conduct.

Getting Help

If you need help, feel free to ask questions by opening an issue or reaching out to the community.

Thank you for your contributions!