Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.77 KB
Raw

Contributing to SetCrafter AI

We welcome contributions to the SetCrafter AI project. If you would like to contribute, please follow the guidelines below.

How to Contribute

  1. Fork the Repository: Start by forking the repository and then cloning your fork to your local machine.

  2. Create a New Branch: Create a new branch for your feature or bug fix.

  3. Develop Your Feature: Make your changes on your branch. Be sure to adhere to the project's coding standards and write clean, maintainable code.

  4. Write Tests: If possible, write tests to cover the new functionality or bug fix.

  5. Document Your Changes: Update the documentation to reflect your changes, if applicable.

  6. Submit a Pull Request: Once you're ready, submit a pull request to the main repository. Provide a clear description of the changes and any relevant issue numbers.

Coding Standards

  • Write clear, readable, and concise code.
  • Follow the PEP 8 style guide for Python code.
  • Comment your code where necessary.

Reporting Issues

If you find a bug or have a suggestion for improving the project, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue if applicable.

Pull Request Process

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  • The Pull Request will be merged once it has been reviewed and approved by a project maintainer.

Thank you for contributing to SetCrafter AI!