Skip to content

Commit

Permalink
deso (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
lazynina authored Sep 21, 2021
1 parent 3eb23d1 commit 105d93a
Show file tree
Hide file tree
Showing 10 changed files with 89 additions and 89 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ assignees: ''
---

Please post all bugs in their respective repositories:
- https://github.com/bitclout/core
- https://github.com/bitclout/backend
- https://github.com/bitclout/frontend
- https://github.com/bitclout/identity
- https://github.com/bitclout/docs
- https://github.com/deso-protocol/core
- https://github.com/deso-protocol/backend
- https://github.com/deso-protocol/frontend
- https://github.com/deso-protocol/identity
- https://github.com/deso-protocol/docs
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ assignees: ''

---

Please propose new CIPs by [creating a new Discussion](https://github.com/bitclout/cips/discussions).
Please propose new DIPs by [creating a new Discussion](https://github.com/deso-protocol/dips/discussions).
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# For now, tag everyone who wants to participate
* @bitclout/reviewers
* @deso-protocol/reviewers
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 BitClout Developer Community
Copyright (c) 2021 DeSo Community Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Clout Improvement Proposals (CIPs)
# DeSo Improvement Proposals (DIPs)

## Context

[BitClout](bitclout.com) is a decentralized social network. All of the code
[DeSo](deso.org) is a decentralized social network. All of the code
and data are totally open and anyone can build on the network or
contribute code to improve it.

The CIPs repo allows developers to submit proposals for major features to get feedback and
The DIPs repo allows developers to submit proposals for major features to get feedback and
buy-in from the community prior to submitting code for review.

**BitClout is not a company, and it doesn't have a board or CEO. Instead,
**DeSo is not a company, and it doesn't have a board or CEO. Instead,
it has a committed developer community that collaborates via this repo.**

## Determining What to Work On

If you would like to contribute to BitClout, we have several kanban boards that contain
If you would like to contribute to DeSo, we have several kanban boards that contain
ordered lists of the current priorities. The higher in the list, the
higher the priority. The boards are currently separated by task size and they are:
- [Small](https://github.com/orgs/bitclout/projects/3)
- [Medium](https://github.com/orgs/bitclout/projects/2)
- [Large](https://github.com/orgs/bitclout/projects/1)
- [Small](https://github.com/orgs/deso-protocol/projects/3)
- [Medium](https://github.com/orgs/deso-protocol/projects/2)
- [Large](https://github.com/orgs/deso-protocol/projects/1)

We recommend new contributors start with small tasks and gradually work their way
up to large tasks. But this shouldn't discourage you from starting with a large task
Expand All @@ -30,12 +30,12 @@ out the guidelines in the next section first.

Changes can be small, medium, or large and there are different guidelines
for each size of change. If you're unsure which guidelines to follow, simply
[ask on Discord](https://discord.gg/bitclout) and someone will help you
[ask on Discord](https://discord.gg/deso) and someone will help you
figure out the right path to submitting your change.

### Small Changes

Small changes do not require a CIP or extended discussion. Simply submit a pull request to the relevant repository
Small changes do not require a DIP or extended discussion. Simply submit a pull request to the relevant repository
and you're done.

Examples of small changes include:
Expand All @@ -44,41 +44,41 @@ Examples of small changes include:
- Fixing small bugs that don't affect consensus
- Correcting inconsistent APIs, logging, or configuration options
- Upgrading dependencies
- Clarify CIP process
- Clarify DIP process

### Medium Changes

For medium changes, please [create a new Discussion](https://github.com/bitclout/cips/discussions/new)
on the CIPs repository. You should explain the change you'd like to make, the rationale for making
For medium changes, please [create a new Discussion](https://github.com/deso-protocol/dips/discussions/new)
on the DIPs repository. You should explain the change you'd like to make, the rationale for making
the change, and how you plan to implement the change.

Once a [core dev](https://github.com/orgs/bitclout/people)
Once a [core dev](https://github.com/orgs/deso-protocol/people)
approves your idea you can get to work and open a pull request on the relevant repositories. You do not need to
open an issue or pull request on the CIPs repo.
open an issue or pull request on the DIPs repo.

Examples of medium changes include:
- Adding a new API endpoint
- Redesigning a frontend component
- Adding new configuration options
- Refactoring one package or a few files
- Change the CIP Process, excl those listed below under Large changes
- Change the DIP Process, excl those listed below under Large changes

### Large Changes

For large changes, a little more work is required. In order, you should:
1. [Create a new Discussion](https://github.com/bitclout/cips/discussions/new) on the CIPs repo
1. [Create a new Discussion](https://github.com/deso-protocol/dips/discussions/new) on the DIPs repo
to get buy-in for your work from the community and at least one
[core dev](https://github.com/orgs/bitclout/people).
[core dev](https://github.com/orgs/deso-protocol/people).
This is not always required. For example, if a core dev already approved your idea
then you can skip this step. Additionally, note that we are actively working to
expand the group of core devs.
2. Once the community and at least one core dev approves your proposal, create a pull request
on the CIPs repo describing your change in full detail.
[Use the CIP template](https://github.com/bitclout/cips/blob/main/cip-template.md) for creating
your CIP.
3. The community and core devs will review your CIP PR and provide feedback. Once
at least two core devs approve, your PR can be merged and is now an official CIP.
4. Now that you have an official CIP, you can confidently submit pull requests to the relevant
on the DIPs repo describing your change in full detail.
[Use the DIP template](https://github.com/deso-protocol/dips/blob/main/cip-template.md) for creating
your DIP.
3. The community and core devs will review your DIP PR and provide feedback. Once
at least two core devs approve, your PR can be merged and is now an official DIP.
4. Now that you have an official DIP, you can confidently submit pull requests to the relevant
repositories to implement your changes. You can also enlist other community or core developers to help you.
5. Once your PRs have at least two approvals from core devs, they can be merged and your
change can go live on the network.
Expand All @@ -87,7 +87,7 @@ Examples of large changes include:
- Changing or adding a transaction
- Any soft or hard fork to consensus
- Refactoring multiple packages or repositories
- A significant change to the CIPs process, including:
- A significant change to the DIPs process, including:
- Change levels & their definitions
- Who approves changes at different levels

4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Security Policy

BitClout encourages responsible vulnerability disclosure for security issues.
DeSo encourages responsible vulnerability disclosure for security issues.

Read the [Bug Bounty documentation](https://docs.bitclout.com/devs/bug-bounty) for more information.
Read the [Bug Bounty documentation](https://docs.deso.org/devs/bug-bounty) for more information.
16 changes: 8 additions & 8 deletions cip-template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
cip: <to be assigned>
title: <CIP title>
title: <DIP title>
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <[email protected]>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
discussions-url: <URL>
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
---

This is the suggested template for new CIPs. Note that a CIP number will be assigned by a core dev.
This is the suggested template for new DIPs. Note that a DIP number will be assigned by a core dev.

## One-Line Description

A very simple description that someone who's quickly scanning CIPs can use to
A very simple description that someone who's quickly scanning DIPs can use to
immediately understand what this change is doing.

## Explanation and Motivation
Provide a simple explanation of the CIP.
Provide a simple explanation of the DIP.

Include an explanation of the "why" behind this CIP. What problem does it solve?
Include an explanation of the "why" behind this DIP. What problem does it solve?

## Specification
The technical specification should describe the new feature in deep technical detail. It should be detailed enough to allow for complete implementation.
Expand All @@ -27,13 +27,13 @@ Include the rationale behind any decisions. If there were any approaches that di
Identify any additional storage requirements in the blockchain due to this change. Carefully consider if there are opportunities to optimize storage requirements.

## Backwards Compatibility
All CIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The CIP must explain how the author proposes to deal with these incompatibilities.
All DIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The DIP must explain how the author proposes to deal with these incompatibilities.

## Test Cases
If this change requires more than just unit tests, include an explanation of how you're going to test your change to make sure it works.

## Security Considerations
All CIPs must contain a section that discusses the security
All DIPs must contain a section that discusses the security
implications/considerations relevant to the proposed change. Include
possible attack vectors or ways this change could cause problems
down the road.
Expand All @@ -45,4 +45,4 @@ not chosen.

## Acknowledgements
If there were additional community members that helped you guide / hone your
thoughts, or members who gave constructive feedback to make this CIP better.
thoughts, or members who gave constructive feedback to make this DIP better.
4 changes: 2 additions & 2 deletions cips/cip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Allow users to delegate signing permissions to another private key using only Ex

Today, iOS and Android apps have full access to a user’s key material. This means
any third-party app can steal the user's key material after they log in, even if
this login ostensibly occurs in a BitClout Identity window.
this login ostensibly occurs in a DeSo Identity window.

To prevent this,
our options are to either require all
Expand All @@ -24,7 +24,7 @@ latter would make it so that the key material the app gets isn't useful after
some period of time, limiting the attack surface.

Most users don’t want to approve every transaction they perform on a third
party app. Core product features like diamonds make transferring CLOUT and creator coins an
party app. Core product features like diamonds make transferring DESO and creator coins an
action users do multiple times per day. Furthermore, we have learned there is
no way to run a signing service in the background on iOS. For all these
reasons, we should solve for providing third party apps with easy access to
Expand Down
Loading

0 comments on commit 105d93a

Please sign in to comment.