Skip to content

Contribution Guidelines

Antonio Fin edited this page Nov 10, 2024 · 1 revision

Contribution Guidelines

Thank you for considering contributing to LL-Mesh! We value the contributions of our community and are excited to welcome new ideas, improvements, and enhancements. There are several ways you can contribute to our project:

1. Contributing to the Self-Serve Platform

  • Adding Functions: Extend our Self-Serve Platform by adding new utility functions or enhancing existing ones. This could involve abstracting lower-level libraries for broader use or creating new domain-specific functions to increase the platform's versatility.

2. Enhancing the Web App examples

  • UI/UX Improvements: If you have expertise in web design or user experience, you can contribute by improving the look, feel, and usability of our Web Apps, making them more intuitive and user-friendly.

3. Creating New Tools

  • Tool Development: We encourage the development of new tools that integrate seamlessly with our platform. Whether it's a simple script or a complex application, your contributions can help expand the project's capabilities.

4. Writing Policies

  • Policy Formulation: Contributions aren’t limited to code. Writing clear, thoughtful policies for ethical AI use and federated governance is crucial. We welcome input from all backgrounds—you don’t need to be a developer to contribute meaningfully here.

5. Writing Tests

  • Test Development: Ensure the quality and reliability of the platform by developing tests for all Self-Serve Platform functions and tools. Comprehensive testing allows for easy refactoring and maintains the integrity of the codebase.

General Guidelines for Contributions

  • Feature Branches: For all contributions, please create a feature branch in the relevant repository. This approach keeps our main branch stable and ensures all changes can be reviewed and tested thoroughly.
  • Pull Requests: Once your feature is ready, submit a pull request for review. Please provide a clear description of the changes and include any relevant documentation to help reviewers understand your contribution.
  • Tool Development in Separate Repositories: If you're developing a new tool, consider doing so in a separate repository. Follow the structure of existing tools for consistency. Once complete, link your tool in this wiki so it can be discovered and used by the community.

We appreciate all contributions, big or small, and are committed to providing a welcoming and collaborative environment. Please adhere to our code of conduct and respect fellow contributors. Your efforts help us build a better platform and a stronger community.

Thank you for contributing to LL-Mesh! If you have any questions or need assistance with your contribution, please reach out to the project maintainers. We’re here to help!