Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 1.26 KB
Raw

Contributing Guideline

Thank you for investing your time in contributing to this project!

Contribution Flow

Each contribution should start with an issue. You should create an issue or start a discussion on the github repository.

What you shouldn't do?

  • Sending directly a PR ❌

What you should do?

  • Creating an Issue about your feature request or bug report. ✅
  • Wait until the Issue is discussed and approved. ✅ (You can fix obvious mistakes right away)
  • Then you can send a PR that closes the Issue. ✅

Contributing to the docs

You can contribute to the docs by sending a PR to the docs folder. Changes will be deployed automatically on the Uranium UI Documentation

Documentation also is versionned and each version has its own documentation. So, be sure about which version you're working on. Versions are related to branch names. For example, the develop branch is for the latest version of the docs and it's not relased yet. The rel-2.1 branch is for the 2.1.* version of the docs and it's released (at least as preview version).