Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.89 KB
Raw

Contributing to the AWS Community Builders Dashboard

Thank you for considering contributing to the AWS Community Builders Dashboard! We welcome contributions from the community and are grateful for your help.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please report them using the GitHub Issues page. When reporting an issue, please include:

  • A clear and descriptive title
  • A detailed description of the issue or suggestion
  • Steps to reproduce the issue (if applicable)
  • Any relevant error messages or screenshots

Submitting Pull Requests

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

  1. Fork the repository: Click the "Fork" button on the top right corner of the repository page on GitHub.

  2. Clone your fork: Clone the forked repository to your local machine:

    git clone https://github.com/robertgv/aws-community-builders-dashboard.git
cd aws-community-builders-dashboard

  3. Create a new branch: Create a new branch for your work to keep changes isolated:

    git checkout -b [your-branch-name]

  4. Make your changes: Implement your changes and ensure they follow the project's coding style and standards.

  5. Test your changes: Run existing tests and add new tests if necessary to ensure your changes work as expected.

    pre-commit run --all-files --show-diff-on-failure

  6. Commit your changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "Description of your changes"

  7. Push your changes: Push your changes to your forked repository:

    git push origin [your-branch-name]

  8. Open a pull request: Go to the original repository on GitHub and open a pull request from your forked branch. Provide a detailed description of your changes and any related issue numbers.

Coding Guidelines

To ensure a consistent codebase, please adhere to the following guidelines:

  • PEP 8: Follow the Python PEP 8 style guide for writing clean and readable code.
  • Comments: Write clear comments to explain the purpose of complex code sections.
  • Docstrings: Use docstrings to document functions, classes, and modules.
  • Testing: Add tests for new features and bug fixes to maintain code quality.

Getting Help

If you need help or have any questions, feel free to reach out by opening an issue on GitHub or contacting the project maintainers:

Thank you for your contributions and support!