Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (39 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 2.39 KB

Contributing to Kwaai's Personal AI Operating System (pAI-OS)

Thank you for your interest in contributing to pAI-OS! We welcome contributions from the community to help make pAI-OS even better.

Getting Started

To get started with contributing to pAI-OS, please follow these steps:

  1. Fork the pAI-OS repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your desired changes to the codebase.
  5. Test your changes thoroughly.
  6. Commit your changes with descriptive commit messages.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main pAI-OS repository.

Code Style

We follow a specific code style in the pAI-OS project to ensure consistency and readability. Please make sure to adhere to the following guidelines:

  • Use consistent indentation (e.g., 4 spaces).
  • Follow the naming conventions for variables, functions, and classes.
  • Write clear and concise comments to explain your code.
  • In documentation, put each sentence on its own line and a blank line between one or more sentences for paragraphs. (This helps with the content review process by making clear where changes occur in a paragraph.)

Reporting Issues

If you encounter any bugs or issues while using pAI-OS, please report them on the GitHub issue tracker. When reporting an issue, please provide the following information:

  • A clear and concise description of the issue.
  • Steps to reproduce the issue.
  • Any relevant error messages or logs.

Feature Requests

If you have an idea for a new feature or improvement for pAI-OS, we would love to hear it! Please open a GitHub issue and provide a detailed description of your proposed feature.

Code Reviews

All contributions to PapAI-OS go through a code review process. This helps ensure the quality and maintainability of the codebase. Please be open to feedback and make any necessary changes based on the code review comments.

License

By contributing to pAI-OS, you acknowledge that your contributions will be licensed under the MIT License and that you have read and certified the Developer Certificate of Origin (DCO).

Contact

If you have any questions or need further assistance, please reach out to the project maintainers at contact@kwaai.ai.

We appreciate your contributions to pAI-OS!