Page cover

Community & Support

🧑‍🤝‍🧑 Community & Contribution

JuliaOS is an open-source project, and we welcome contributions from the community! Whether you're a developer, a researcher, or an enthusiast in decentralized technologies, AI, and blockchain, there are many ways to get involved.

Join Our Community

The primary hub for the JuliaOS community is our GitHub repository:

  • GitHub Repository: https://github.com/Juliaoscode/JuliaOS

    • Issues: Report bugs, request features, or discuss specific technical challenges.

    • Discussions: (Consider enabling GitHub Discussions) For broader questions, ideas, and community conversations.

    • Pull Requests: Contribute code, documentation, and improvements.

Ways to Contribute

We appreciate all forms of contributions, including but not limited to:

  • 💻 Code Contributions:

    • Implementing new features for agents, swarms, or neural network capabilities.

    • Adding support for new blockchains or bridges.

    • Improving existing code, performance, or security.

    • Writing unit and integration tests.

    • Developing new use cases or example applications.

  • 📖 Documentation:

    • Improving existing documentation for clarity and completeness.

    • Writing new tutorials or guides.

    • Adding examples to the API reference.

    • Translating documentation.

  • 🐞 Bug Reports & Testing:

    • Identifying and reporting bugs with clear reproduction steps.

    • Helping test new releases and features.

  • 💡 Ideas & Feedback:

    • Suggesting new features or enhancements.

    • Providing feedback on the project's direction and usability.

  • ** evangelism & Advocacy:**

    • Spreading the word about JuliaOS.

    • Writing blog posts or creating videos about your experiences with JuliaOS.

Getting Started with Contributions

  1. Set Up Your Environment: Follow the Quick Start

  2. Find an Issue: Browse the GitHub Issues page. Look for issues tagged with good first issue or help wanted if you're new.

  3. Discuss Your Plans: For new features or significant changes, it's a good idea to open an issue first to discuss your ideas with the maintainers and community.

  4. Contribution Workflow:

    • Fork the JuliaOS repository to your own GitHub account.

    • Create a new branch for your changes (e.g., git checkout -b feature/my-new-feature or fix/bug-description).

    • Make your changes, adhering to any coding style guidelines (to be defined, see below).

    • Write or update tests for your changes.

    • Commit your changes with clear and descriptive commit messages.

    • Push your branch to your fork on GitHub.

    • Open a Pull Request (PR) against the main or appropriate development branch of the Juliaoscode/JuliaOS repository.

    • Clearly describe the changes in your PR and link to any relevant issues.

    • Be responsive to feedback and participate in the review process.

Contribution Guidelines

We are in the process of formalizing our contribution guidelines. In the meantime, please aim for:

  • Clear Code: Write readable and maintainable code. Add comments where necessary.

  • Testing: Include tests for new functionality and bug fixes.

  • Commit Messages: Write clear and concise commit messages (e.g., following Conventional Commits).

We plan to create a CONTRIBUTING.md file with detailed guidelines soon.

Code of Conduct

We are committed to fostering an open, welcoming, and inclusive community. All contributors and participants are expected to adhere to a Code of Conduct. We plan to adopt and publish a CODE_OF_CONDUCT.md file (e.g., based on the Contributor Covenant) in the near future.

Last updated