Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 2.33 KB
Raw

Contributing to CloudLens

Thank you for considering contributing to CloudLens! We welcome contributions from anyone, regardless of their level of experience or expertise. By contributing, you can help us improve our terminal UI for AWS and make it more useful for our users.

Getting Started

To get started with contributing to CloudLens, you should:

  1. Fork the CloudLens repository on GitHub.
  2. Clone your fork to your local machine using git clone.
  3. Create a new branch for your changes using git checkout -b.
  4. Make your changes to the code or documentation.
  5. Test your changes to ensure they work as intended.
  6. Commit your changes using git commit.
  7. Push your changes to your fork using git push.
  8. Open a pull request on the CloudLens repository.

Types of Contributions

We welcome the following types of contributions to CloudLens:

  • Bug reports and fixes
  • Feature requests and implementations
  • Documentation improvements
  • Code reviews and feedback
  • Translations of the user interface

Reporting Issues

If you encounter a bug or issue with CloudLens, please report it on our GitHub issues page. To ensure that we can reproduce the issue and fix it quickly, please include:

  • A detailed description of the problem
  • Steps to reproduce the problem
  • Any error messages or logs that were generated
  • Any additional information that may be relevant

Code Reviews and Feedback

All contributions to CloudLens are reviewed by other members of the community before they are merged. We welcome feedback on code changes and suggestions for improvements. When reviewing code, please:

  • Be respectful and considerate towards the contributor.
  • Focus on the code itself, not the person who wrote it.
  • Provide specific and actionable feedback that the contributor can use to improve their code.
  • Acknowledge and appreciate the effort and time that the contributor has put into the contribution.

Licensing

All contributions to CloudLens are subject to the project's license. By contributing, you agree to license your contributions under the same terms as the project. If you are contributing on behalf of your employer, you must ensure that they agree to license your contributions under the project's license.

Attribution

This contribution.md file is based on various GitHub projects, including the Flask, Django, and Atom projects.