Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 3.13 KB
Raw

Contributing to DIMO Hello World

Thank you for your interest in contributing to the DIMO Hello World repository! We're excited to collaborate with the community to expand the collection of examples showcasing the diverse capabilities of DIMO's platform, including our REST API, Streamr integration, GraphQL API, and more.

How to Contribute

Contributions can take many forms, from fixing typos in documentation to adding new examples. Here's how you can contribute:

Reporting Issues

If you find a bug or have a suggestion for improving an existing example, please open an issue. Be as specific as possible and include:

  1. A clear title and description
  2. Steps to reproduce the issue, if applicable
  3. Your ideas for solving the issue, if any

Adding New Examples

We welcome examples that showcase new frameworks, languages, or integrations with DIMO's infrastructure. To contribute a new example:

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Create a New Branch: Create a branch in your forked repository for your contribution.
  3. Develop Your Example: Ensure your example adheres to the following guidelines:
    • Uniqueness: Your example should be unique and help other developers understand how to build with DIMO.
    • Readability: Code should be clean, well-commented, and easy to understand.
    • Consistency: Code should be as idomatic consistent as possible.
    • Documentation: Include a README.md in your example's directory explaining what it does, how to set it up, and how to run it.
    • Dependencies: Keep external dependencies to a minimum, attempt to be as.
  4. Test Your Example: Thoroughly test your example to ensure it works as expected.
  5. Submit a Pull Request: Once your example is ready and tested, submit a pull request to the main repository. In your PR description, explain the purpose of your example and how it works.

Improving Documentation

Good documentation is crucial to helping others understand and use the examples. If you see an opportunity to improve documentation, whether it's fixing typos or clarifying instructions, your contributions are welcome.

Contribution Guidelines

  • Code of Conduct: All contributors are expected to adhere to the repository's code of conduct. Be respectful and provide constructive feedback to your community members.
  • License: By contributing to the DIMO Hello World repository, you agree that your contributions will be licensed under its Apache 2.0 License.
  • Quality Standards: Contributions should meet the quality standards outlined in this document, including uniqueness, readability, consistency, documentation, and minimal dependencies.

Getting Help

If you have any questions or need help with your contribution, please open an issue for discussion. We're here to help make your contribution matter and a success.

Acknowledgments

Your contributions are a valuable part of the DIMO community's efforts to showcase the power and flexibility of DIMO, and of course, improve the quality of services that we provide. Thank you for your support and collaboration!