Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

88 lines (58 loc) · 3.75 KB

Contributing to 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.

By making contributions, you are signing off on the Developer Certificate of Origin (DCO) below.

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.

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 pAI-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 permissive software license/s (currently the MIT License) and that you have read and signed-off on the Developer Certificate of Origin (DCO), whether or not you explicitly sign-off on each commit.

Contact

If you have any questions or need further assistance, please reach out to the project maintainers at [email protected].

We appreciate your contributions to pAI-OS!

Certification

Developer Certificate of Origin Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.