Skip to content

Latest commit

 

History

History
94 lines (50 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

94 lines (50 loc) · 3.12 KB
Raw

Contribution Guide

Thank you for your interest and support in Dora SSR! We welcome contributions from anyone to this project. Here are some suggestions and guidelines to help you get started with contributing to the project.


Reporting Issues

If you encounter any issues while using Dora SSR, please submit an Issue in the GitHub repository. Before submitting an Issue, please ensure:

  1. Check existing Issues to avoid duplicate reports.

  2. Describe the issue in detail, including expected behavior and what actually occurred.

  3. If possible, provide a simple example code that reproduces the issue.


Feature Suggestions

We greatly appreciate your suggestions for new features in Dora SSR. Before submitting a feature suggestion, please ensure:

  1. Your suggestion aligns with the goals and vision of Dora SSR.
  2. Provide sufficient details so we can understand your needs and the proposed implementation.

Code Contributions

If you would like to contribute code to Dora SSR, please follow these steps:

  1. Fork the Project:

    Fork the project repository.

  2. Branch Creation:

    Create a new branch locally to make changes.

  3. Build from Source:

    Familiarize yourself with the project's compile-from-source process by referring to the Build-from-Source Documentation.

  4. Coding:

    Write the code and ensure it adheres to the project's coding standards.

    Coding Style Guidelines:

    • We adhere to a coding style to maintain consistency and readability across the project. Our style is defined in the clang-format config file located here.
    • Before submitting your code, please ensure running clang-format on your code.

  5. Commit and Push:

    Commit the changes and push them to your forked repository.

  6. Submit a Pull Request:

    Create a Pull Request, describing your changes and their rationale in detail.


Documentation Contributions

Documentation is crucial to the success of any open-source project. If you find errors in the documentation or believe it can be improved, please submit an Issue or Pull Request.


Developer Certificate of Origin (DCO)

By contributing to this project, you agree to the terms of the Developer Certificate of Origin. This means that:

  1. The code you are submitting is your own or you have permission to contribute it.
  2. You agree to license your contribution under the same license as the project.

To indicate that you accept these terms, you must include a Signed-off-by line in your commit message:

Signed-off-by: Your Name [email protected]

You can add this automatically by running git commit -s when you make a commit.


Community Support

You can provide support to the community by answering questions, providing tutorials, and sharing example projects. If you have any resources that can help other developers, please share them in related community forums and chat rooms.


We hope this contribution guide helps you get started with contributing to Dora SSR. Thank you again for your support, and we look forward to your contributions!