Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (23 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.71 KB

Contributing to 01cloud-admin

First off, thank you for considering contributing to 01cloud-admin! It's people like you that make open source such a great community to learn, inspire, and create.

How to Contribute

1. Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to maintain a welcoming and inclusive environment.

2. Reporting Bugs

If you find a bug, please create an issue on GitHub.

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Note for Security Vulnerabilities: If you find a security vulnerability, do NOT open an issue. Please read SECURITY.md for reporting instructions.

3. Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When you create an issue, please provide a clear and descriptive title and a detailed description of the proposed enhancement.

4. Pull Requests

  1. Fork the repo and create your branch from main.
  2. Develop your changes ensuring the code conforms to the existing style.
  3. Run Pre-Commit Hooks: The project uses pre-commit to ensure code styles, linting, and security scans (including Gitleaks) are applied. 
    pre-commit run --all-files
  4. Test your code: Make sure tests pass and functionality works as expected.
  5. Issue a Pull Request: Detail your changes and wait for a review!

Again, thank you for contributing!