Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (32 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.89 KB
Raw

Contributing to aws_resource_validator

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

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.

Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing feature, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any relevant examples or use cases.

Pull Requests

We welcome pull requests for bug fixes, new features, and documentation improvements. To submit a pull request, follow these steps:

  1. Fork the repository and create your branch from main.
  2. Make your changes in your forked repository.
  3. Ensure your code follows our coding standards and passes all tests.
  4. Update documentation as needed.
  5. Open a pull request against the main branch with a clear and descriptive title.

Coding Standards

  • Follow PEP 8 for Python code.
  • Write clear and concise commit messages.
  • Ensure your code is well-documented.

Testing

Ensure that your code passes all tests before submitting a pull request. If you add new functionality, please include tests to verify it.

Communication

If you need help or have questions, feel free to reach out to us at alexy.grabov@gmail.com or ytupman@gmail.com.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expected behavior.

Thank you for contributing to aws_resource_validator!