Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

78 lines (44 loc) · 3.35 KB
Raw

Contribution Guidelines 🤝

Welcome to the CryptoSnap project! We're excited to have you as a contributor. Your contributions are invaluable in shaping the future of this project. Please take a moment to review these guidelines before you get started.

Table of Contents

Code of Conduct 📜

As a contributor, you agree to adhere to our Code of Conduct. Please make sure to read it thoroughly to ensure a positive and respectful environment for everyone.

How Can I Contribute? 🚀

There are several ways you can contribute to CryptoSnap:

  • Reporting Bugs: If you come across a bug or an issue, please report it.
  • Suggesting Enhancements: If you have ideas for improving the project, please suggest enhancements.
  • Contributing Code: If you're a developer, you can contribute code changes by following the Pull Request Process.

Reporting Bugs 🐛

To report a bug, please follow these steps:

  1. Check the GitHub Issues to see if the bug has already been reported.

  2. If it hasn't been reported, create a new issue. Be sure to include a clear and detailed description of the bug, including steps to reproduce it.

  3. Provide any relevant screenshots or error messages to help us understand the issue better.

  4. Use the "Bug" label and include the appropriate labels for the affected area (e.g., UI, API, etc.).

Suggesting Enhancements ✨

If you have ideas for enhancing the project, follow these steps:

  1. Check the GitHub Issues to see if your idea has already been suggested.

  2. If it hasn't been suggested, create a new issue. Provide a clear and detailed description of your enhancement idea.

  3. Use the "Enhancement" label and include the appropriate labels for the area of improvement (e.g., UI, API, etc.).

Pull Request Process 📦

If you'd like to contribute code to CryptoSnap, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch with a descriptive name for your feature or bug fix.

  3. Make your changes and ensure they adhere to our Coding Style.

  4. Test your changes thoroughly to ensure they work as expected.

  5. Make sure your code is well-documented and includes comments where necessary.

  6. Create a pull request and provide a detailed description of your changes.

  7. Include any relevant screenshots or information to help reviewers understand your changes.

  8. A maintainer will review your pull request and provide feedback.

  9. Once your pull request is approved, it will be merged into the main branch.

Coding Style 🧰

Please follow the coding style and guidelines used in the project to maintain consistency. We appreciate clean, well-documented code.

License 📃

By contributing to CryptoSnap, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to CryptoSnap! Your efforts help make this project better for everyone. 🚀