Skip to content

Contributing

Jump to bottom
Shannon Atkinson edited this page Oct 30, 2024 · 1 revision

Contributing

Thank you for your interest in contributing to the No-Code Architects Toolkit! We welcome contributions that improve the toolkit, add features, fix bugs, or enhance documentation. This guide will help you get started with contributing effectively.

Getting Started

  1. Fork the Repository:

    • First, fork the project repository on GitHub. This creates a copy of the repository under your account, where you can make changes without affecting the main project.
    • To fork, navigate to the GitHub repository page and click on the “Fork” button.

  2. Clone Your Fork:

    • After forking, clone your forked repository to your local machine:
    git clone https://github.com/stephengpope/No-Code-Architects-Toolkit.git
cd No-Code-Architects-Toolkit

  3. Create a Branch:

    • Always create a new branch for your changes. Name the branch according to the feature or bug fix you’re working on. For example:
    git checkout -b feature-new-api-endpoint

  4. Set Up the Environment:

    • Follow the Getting Started guide to configure and run the toolkit locally.
    • Be sure to create a .env file with the necessary environment variables to avoid affecting production resources.

Making Changes

  1. Code Style:

    • Ensure that your code follows the project’s style guidelines. We recommend using black for consistent code formatting:
    pip install black
black .

  2. Write Tests:

    • When adding new features or modifying existing functionality, create corresponding tests in the tests directory.
    • Make sure that all tests pass before submitting your pull request.

  3. Document Your Changes:

    • If you’re adding a new feature, update relevant documentation files. This includes the API endpoints documentation and any configuration requirements.
    • If you’re fixing a bug, document the fix clearly in the pull request description.

Submitting a Pull Request

  1. Commit Your Changes:

    • Write clear, concise commit messages explaining your changes:
    git add .
git commit -m "Add feature to support custom S3 buckets"

  2. Push Your Branch:

    • Push your branch to your forked repository on GitHub:
    git push origin feature-new-api-endpoint

  3. Open a Pull Request:

    • Navigate to the original repository and open a pull request (PR) from your branch. Include a descriptive title and summary of the changes made.
    • Mention any related issues in the PR description to help maintainers understand the context.
    • If applicable, add screenshots or examples demonstrating the changes.

  4. Address Feedback:

    • Maintainers may review your pull request and leave feedback or request changes. Be prepared to make adjustments as needed to get your PR approved.
    • Once all feedback is addressed, your PR will be merged into the main repository.

Guidelines

  • Be Respectful: Please maintain a positive and respectful tone when communicating with other contributors.
  • Stay Focused: Make sure each pull request is focused on a single feature, bug fix, or improvement. Large or unrelated changes may be split into separate PRs.
  • Collaborate: Feel free to discuss major changes with the project maintainers before implementing them. This can help ensure your efforts align with the project’s goals and save time on revisions.

Reporting Issues

If you encounter any bugs or have feature suggestions, please open an issue on the GitHub repository. When reporting an issue:

  • Describe the issue in detail.
  • Include steps to reproduce the problem, if applicable.
  • Mention the expected behavior versus the actual outcome.
  • Provide any relevant logs or screenshots that may help in diagnosing the issue.

Thank You!

Your contributions help make the No-Code Architects Toolkit better for everyone. We appreciate your time, effort, and expertise in helping improve the project.

Happy coding!

Clone this wiki locally