Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (71 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

104 lines (71 loc) · 3.07 KB

Contributing to PersistenceAI

Thank you for your interest in PersistenceAI! This document provides guidelines for providing feedback and reporting issues.

📝 Project Status

PersistenceAI is currently a closed-source project. The core codebase is proprietary. However, we may selectively open-source certain components, tools, or integrations in the future.

🤝 How You Can Help

Reporting Bugs

If you find a bug, please open an issue with:

  • Clear title describing the bug
  • Steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Environment details (OS, version, etc.)
  • Screenshots/logs if applicable

Suggesting Features

We welcome feature suggestions! Please open an issue with:

  • Clear description of the feature
  • Use case - why is this feature needed?
  • Proposed solution (if you have one)
  • Alternatives considered (if any)

Documentation Improvements

For public repositories (like Landing), we welcome documentation improvements:

  1. Fork the repository (if it's open source)
  2. Create a feature branch (git checkout -b docs/improvement)
  3. Make your changes
  4. Commit your changes (git commit -m 'Improve documentation')
  5. Push to the branch (git push origin docs/improvement)
  6. Open a Pull Request

Code Contributions

Note: Code contributions are currently limited to:

  • Public repositories (if any)
  • Documentation-only changes
  • Example code or templates

For core codebase contributions, please contact us directly at PersistenceAI@proton.me to discuss opportunities.

📝 Code Style

  • Follow existing code patterns
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and small
  • Write self-documenting code

🧪 Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Test on multiple platforms if applicable

📚 Documentation

  • Update README if adding new features
  • Add code comments for complex logic
  • Update API documentation if changing interfaces

🎯 Development Setup

  1. Clone the repository
  2. Install dependencies
  3. Run tests
  4. Make your changes
  5. Test your changes
  6. Submit a PR

📋 Commit Message Guidelines

Use clear, descriptive commit messages:

  • feat: Add new feature
  • fix: Fix bug in X
  • docs: Update documentation
  • refactor: Refactor code
  • test: Add tests
  • chore: Update dependencies

🔍 Code Review Process

  1. PRs will be reviewed by maintainers
  2. Address any feedback
  3. Once approved, your PR will be merged

📜 License & Ownership

  • Closed-source components: All rights reserved. Proprietary code.
  • Open-source components: Will be licensed under appropriate open-source licenses when released.
  • Documentation contributions: By contributing documentation, you agree that your contributions will be licensed under the same license as the documentation repository.

🙏 Thank You!

Your feedback and suggestions help make PersistenceAI better for everyone. Thank you for taking the time to help improve PersistenceAI!