-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
131 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| Contributing to U°OS | ||
| ==================== | ||
|
|
||
| Table of Contents | ||
| ----------------- | ||
|
|
||
| * [Introduction](#introduction) | ||
| * [Project Repositories](#repos) | ||
| * [Working with Issues](#issues) | ||
| * [Working with UIPs](#uips) | ||
| * [Documentation](#docs) | ||
| * [Developer Environment](#environment) | ||
| * [Testing](#testing) | ||
| * [Submitting Changes](#commits) | ||
| * [Coding Conventions](#codestyle) | ||
| * [Code of Conduct](#conduct) | ||
| * [List of Releases](#releases) | ||
| * [Communication](#communication) | ||
|
|
||
| Introduction <a name="introduction"></a> | ||
| ---------------------------------------- | ||
|
|
||
| ### Intended audience | ||
|
|
||
| * Project contributors | ||
| * App developers | ||
| * Dapp developers | ||
| * Issue reporters | ||
| * Improvement reporters | ||
|
|
||
| ### Core components: | ||
|
|
||
| * Block Producer Node | ||
| * Calculator Node | ||
|
|
||
| Project Repositories <a name="repos"></a> | ||
| ----------------------------------------- | ||
|
|
||
| *Populate when done reorging.* | ||
|
|
||
| Working with Issues <a name="issues"></a> | ||
| ----------------------------------------- | ||
|
|
||
| ### Issue tracker | ||
|
|
||
| * github/UOSnetwork/repo/issues | ||
| * github/UOSnetwork/repo/issues | ||
|
|
||
| ### Submitting an Issue | ||
|
|
||
| See [Issue Template](issue_template.md). | ||
|
|
||
| Working with UIPs <a name="uips"></a> | ||
| ------------------------------------- | ||
|
|
||
| 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 | ||
|
|
||
| github/UOSnetwork/repo/issues | ||
|
|
||
| ### Submitting an UIP | ||
|
|
||
| Submit a UIP as a pull request to the UIP repository: github/UOSnetwork/repo/ | ||
|
|
||
| See [UIP Template](uip_template.md). | ||
|
|
||
| Documentation <a name="docs"></a> | ||
| --------------------------------- | ||
|
|
||
| *Populate soon*. | ||
|
|
||
| Developer Environment <a name="environment"></a> | ||
| ------------------------------------------------ | ||
|
|
||
| *Populate soon*. | ||
|
|
||
| Testing <a name="testing"></a> | ||
| ------------------------------ | ||
|
|
||
| *Populate soon*. | ||
|
|
||
| Submitting Changes <a name="commits"></a> | ||
| ----------------------------------------- | ||
|
|
||
| ### 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](commit_message.md). | ||
|
|
||
| #### 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](https://help.github.com/articles/github-flow/). | ||
|
|
||
| Coding Conventions <a name="codestyle"></a> | ||
| ------------------------------------------- | ||
|
|
||
| * [EOSIO Coding Standards](https://developers.eos.io/eosio-home/docs/coding-standards) | ||
| * [JavaScript](https://standardjs.com/) | ||
| * [React](https://github.com/airbnb/javascript/tree/master/react) | ||
|
|
||
| Code of Conduct <a name="conduct"></a> | ||
| -------------------------------------- | ||
|
|
||
| See [Code of Conduct](code_of_conduct.md). | ||
|
|
||
| List of Releases <a name="releases"></a> | ||
| ---------------------------------------- | ||
|
|
||
| See [Releases and Release Notes](releases.md). | ||
|
|
||
| Communication <a name="communication"></a> | ||
| ------------------------------------------ | ||
|
|
||
| * Gitter: https://gitter.im/home/explore#createcommunity | ||
| * Telegram: [UOS Network Chat](https://t.me/uos_network_en) | ||
| * Discord: [UOS Network Chat](https://discord.gg/Bcq2Q5C) |