Skip to content

Latest commit

 

History

History
156 lines (107 loc) · 5.38 KB

CONTRIBUTING.md

File metadata and controls

156 lines (107 loc) · 5.38 KB
Raw

Contributing to U°OS

Table of Contents

Introduction

Intended audience

  • Project contributors
  • App developers
  • Dapp developers
  • Issue reporters
  • Improvement reporters

Core components:

  • Block Producer Node
  • Calculator Node

U°Community is deployed as a dapp and has a fronted and a backend for interface.

Project Repositories

  • ucom.frontend — U°Community frontend
  • singularity — DPOI
  • ucom.backend — U°Community backend
  • ucom.libs.social.transactions — U°Community user transactions on U°OS
  • ucom.libs.wallet — U°Community wallet for U°OS
  • uos.plugins — Rate of entities on U°OS. Entities: posts, articles, comments, users, organizations, communities. Also displayed on U°Community.
  • uos — U°OS blockchain software
  • uos.docs — U°OS Framework documentation repository
  • uos.uip — U°OS Network improvement proposals
  • ucom.uip — U°Community improvement proposals
  • mongo-c-driver — A cross-platform MongoDB client library for C. Used as part of the U°OS project to provide library compatibility to cache account names.
  • uos.contracts — U°OS Network contracts for entity rates
  • tribute — User mentions for U°Community
  • uos.libs — DEPRECATED

Working with Issues

Issue tracker

Click Issues in the repository to see the reported issues.

Submitting an Issue

See Issue Template.

Working with UIPs

UIP is short for U°OS Improvement Proposal.

A UIP is what you submit to improve the U°OS protocol. A UIP is always a community decision and must go through a detailed discussion with the community members.

UIP tracker

UIPs are tracked in the uos.uip repository.

Submitting a UIP

Submit a UIP as a pull request to the UIP repository: github/UOSnetwork/repo/

See UIP Template.

Documentation

U°OS and U°Community documentation hub.

Developer Environment

Check README.md of each repository.

Testing

Check README.md of each repository.

Submitting Changes

Intent

The goals of contributing to U°OS:

  • Maintain the quality of code, developer experience, user experience
  • Fix issues
  • Engage the community to make the best possible U°OS

Instructions

Commit messages

See Commit Message Style Guide.

Fixing a bug

  1. Check the Issue Tracker first to see if the bug's been reported and/or fixed.
  2. If the bug hasn't been submitted yet, submit it first.
  3. Write a comment in the issue tracker that you are working on the bug.
  4. Submit your fix in accordance with the regular GitHub flow.

Coding Conventions

Code of Conduct

See Code of Conduct.

List of Releases

See Releases and Release Notes.

Spinning up a Node

For a detailed walkthrough see Spinning up a Block Producer Node on Ubuntu.

Licensing

Both U°OS and U°Community are open source and under public licensing. For details, check the LICENSE.md file in each repository.

Communication