Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

56 lines (33 loc) · 2.66 KB
Raw

Contributing to URSA

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the Contributor Covenant Code of Conduct. Please read and follow our Code of Conduct. We expect all contributors to be respectful and considerate of others in all interactions.

Language

Currently the core maintainer team can only understand Chinese and English. You are welcomed to submit issues, discussions or pull requests with any language, but we can't not guarantee an accurate understanding of your thought with the help of machine translation.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please submit an issue by following these steps:

  1. Search existing issues to ensure the bug hasn't already been reported. They are usually in Github Issues or GitHub Discussions

  2. Open a new issue and include:

    • A clear description of the problem.
    • Steps to reproduce the bug.
    • Screenshots or logs, if applicable.
    • Your environment details (OS, browser version, etc.).

Feature Requests

We welcome new ideas! To suggest a feature:

  1. Check existing issues to see if your feature has already been suggested. They are usually in Github Issues or GitHub Discussions
  2. Open a feature request with:
    • A detailed explanation of the feature.
    • The problem the feature would solve.
    • Potential alternatives, if any.

Code Contributions

We love code contributions, whether they fix a bug, add a feature, or improve existing code. We follow the general process of accepting your code contribution.

Before Contributing

Features should be discussed with the core team before opening a PR. Please open an issue to discuss the feature before starting work. We will help you understand whether your new feature is following URSA's design philosophy. We also need to review if the new feature introduce any major breaking chnages in major lifecycle.

Open a Pull Request

To contribute with a Pull Request, you need to:

  1. Fork the repository and clone your fork locally.
  2. Create a new branch for your changes.
  3. Make your changes, following the Style Guide. Write or update unit tests for any new or changed functionality.
  4. Commit your changes with a descriptive commit message.
  5. Push your branch to GitHub and open a Pull Request with detailed explanation.