Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 2.72 KB
Raw

CONTRIBUTING.md

First of all, thank you for your interest in contributing to PuttyGPT! We appreciate your time and effort to help make this project better. ??

Please note that this is a very early version of the project, and we are still in the process of wrapping things up, wiring components together, and experimenting with new ideas. As such, the project may undergo significant changes and updates as we continue to evolve and refine our vision.

With that said, we still welcome contributions in various forms. Please follow these guidelines to ensure a smooth and effective contribution process.

?? How to Contribute

  1. Fork the repository: Start by forking the PuttyGPT repository and creating a local clone on your computer.
  2. Create a branch: Create a new branch based on the main branch. Use a descriptive name for your branch, such as feature/your-feature-name or fix/your-fix-name.
  3. Commit your changes: Make your changes or additions to the code, ensuring that your changes adhere to the project's code style and guidelines. Commit your changes with a clear and concise commit message.
  4. Test your changes: Before submitting your contribution, ensure that your changes pass all tests and do not introduce any new bugs or issues.
  5. Create a pull request: Once your changes are ready, push your branch to your forked repository and create a pull request against the main branch of the PuttyGPT repository. In the pull request, provide a detailed description of your changes and the reasoning behind them.
  6. Wait for a review: Maintainers will review your pull request, and they may request changes or provide feedback. Please be patient and responsive to their comments.

?? Important Notice

While we appreciate all contributions, please keep in mind that we are in the early stages of the project, and significant changes may occur. Therefore, please understand that your contribution might not be merged immediately, or it might be affected by subsequent updates to the project. We still encourage you to contribute, as your ideas and expertise can help shape the future of PuttyGPT.

?? Code of Conduct

As a contributor, you are expected to uphold our Code of Conduct. Please be respectful, inclusive, and professional in all interactions with the project and its community.

?? Questions or Concerns

If you have any questions or concerns, feel free to reach out to the project maintainers or open an issue on the repository.

Again, thank you for your interest in contributing to PuttyGPT! Your efforts can help make this project even more successful. ??