Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 2.39 KB
Raw

Contributing to Prism

Hi there!

Thank you for considering contributing to Prism. We value the contributions of each individual and are excited to have you as part of our community.

Code of Conduct

If you participate in this project, you will be expected to abide by our Code of Conduct, which promotes respect and inclusion. We all know that everyone, including ourselves, is affected by Imposter Syndrome. We are open and grateful for all suggestions on how to improve the project, even if you are sometimes a little unsure of how good they are. Our goal is to foster a collaborative environment where we can openly discuss ideas and learn together. Any form of harassment or discrimination will not be tolerated.

Types of Contributions

We welcome various forms of contributions, including but not limited to:

  • Code submissions
  • Documentation improvements
  • Bug reports
  • Feature suggestions

Setting Up Your Development Environment

Please refer to the README.md for detailed instructions on setting up your development environment to start contributing.

Pull Request Guidelines

  • Ensure your code adheres to the Rust Coding Standards.
  • Write clear and descriptive commit messages.
  • Create a separate branch for each feature or bug fix.
  • Include tests where applicable.
  • Make a proposal to update the README.md with details of the changes, if necessary.

Reporting Bugs

When reporting a bug, please include:

  • A clear and descriptive title.
  • A step-by-step description of how to reproduce the issue.
  • Any relevant logs or error messages.
  • Your environment details (OS, compiler version, etc.).

Feature Requests

Feel free to submit feature requests via Issues. Please include:

  • A clear and concise description of what you want to achieve.
  • Any considerations or potential challenges.
  • How this feature will benefit the project.

Review Process

All submissions will be reviewed by the maintainers. Feedback or requests for changes may be given. We strive to process contributions promptly.

Acknowledgments

Special thanks to Ryan Ford for his invaluable contributions to this project, especially in raising the quality of using Github to a new level to enable open source work.

Contact

For any questions or assistance, please reach out to us at [email protected].