Skip to content

Commit

Permalink
[chore] update various docs to reflect new location of repo (anza-xyz#12
Browse files Browse the repository at this point in the history
)
  • Loading branch information
sblackshear authored Apr 13, 2022
1 parent 2771ee6 commit 8625c74
Show file tree
Hide file tree
Showing 14 changed files with 24 additions and 278 deletions.
Binary file removed .assets/diem.png
Binary file not shown.
2 changes: 0 additions & 2 deletions .github/CODEOWNERS

This file was deleted.

6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "\U0001F41B Bug report"
about: Create a bug report to help improve Diem Core
about: Create a bug report to help improve Move
title: "[Bug]"
labels: bug
assignees: ''
Expand All @@ -10,7 +10,7 @@ assignees: ''
# 🐛 Bug

<!-- A clear and concise description of what the bug is.
To report a security issue, please email security@diem.com. -->
To report a security issue, please email build@mystenlabs.com. -->

## To reproduce

Expand All @@ -32,7 +32,7 @@ To report a security issue, please email [email protected]. -->
## System information

**Please complete the following information:**
- <!-- Diem Version -->
- <!-- Move Version -->
- <!-- Rust Version -->
- <!-- Computer OS -->

Expand Down
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/documentation_bug_report.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "\U0001F680 Feature request"
about: Suggest a new feature in Diem Core
about: Suggest a new feature in Move
title: "[Feature Request]"
labels: enhancement
assignees: ''
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/questions.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: ❓ Questions/Help
about: If you have questions, please check Discourse
about: If you have questions, please check Discord
---

## ❓ Questions and Help

### Please note that this issue tracker is not a help form and this issue will be closed.

Please contact the development team on [Discourse](https://community.libra.org)
Please contact the development team on [Discord](https://discord.com/invite/M95qX3KnG8)
8 changes: 0 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ Network Trash Folder
Temporary Items
.apdisk

# Generated VM config in vm-genesis
diem-move/vm-genesis/genesis/vm_config.toml

# Terraform
.terraform/

Expand All @@ -49,11 +46,6 @@ build/
.trace
*.mvcov

# Do not ignore the Move build output under the releases for DPN, core, and
# experimental -- these are the release code.
!diem-move/diem-framework/DPN/releases/artifacts/**
!diem-move/diem-framework/experimental/releases/artifacts/**

# Docker incremental build temporary files and directories
target-out-docker
**/Dockerfile.tmp
Expand Down
51 changes: 5 additions & 46 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,21 @@
---
id: contributing
title: Contributing to Diem
title: Contributing to Move
---

Our goal is to make contributing to the Diem project easy and transparent.

> **Note**: As the Diem Core project is currently an early-stage prototype, it
> is undergoing rapid development. While we welcome contributions, before
> making substantial contributions be sure to discuss them in the Discourse
> forum to ensure that they fit into the project roadmap.
## On Contributing

### Diem Core

To contribute to the Diem Core implementation, first start with the proper
development copy.

To get the development installation with all the necessary dependencies for
linting, testing, and building the documentation, run the following:
```bash
git clone https://github.com/diem/diem.git
cd diem
git clone https://github.com/move-language/move.git
cd move
./scripts/dev_setup.sh
cargo build
cargo xtest
```

## Our Development Process

#### Code Style, Hints, and Testing

Refer to our [Coding
Guidelines](https://github.com/diem/diem/blob/main/documentation/coding_guidelines.md) for
detailed guidance about how to contribute to the project.

#### Documentation

Diem's developer website is also open source (the code can be found in this
[repository](https://github.com/diem/diem/tree/main/developers.diem.com)). It is built using
[Docusaurus](https://docusaurus.io/):

## Developer Workflow

Expand Down Expand Up @@ -82,14 +58,6 @@ the area is an identifier for the general area of the code being modified, e.g.
* [language] removing VerificationPass trait
```

A non-exhaustive list of some other areas include:
* consensus
* mempool
* network
* storage
* execution
* vm

Following the commit title (unless it alone is self-explanatory), there should
be a single blank line followed by the commit body which includes more
detailed, explanatory text as separate paragraph(s). It is recommended that the
Expand All @@ -110,7 +78,7 @@ the format "abbreviated sha1 (subject, date)", with the subject enclosed in a
pair of double-quotes, like this:

```bash
Commit 895b53510 ("[consensus] remove slice_patterns feature", 2019-07-18)
Commit 895b53510 ("[vm] use slices instead of evecotrs", 2021-08-19)
noticed that ...
```

Expand Down Expand Up @@ -162,18 +130,9 @@ every commit is able to be built and passes all lints and tests. So if your
pull request includes multiple commits be sure that each and every commit is
able to be built and passes all checks performed by CI.

## Contributor License Agreement

For pull request to be accepted by any Diem projects, a CLA must be signed.
You will only need to do this once to work on any of Diem's open source
projects. Individuals contributing on their own behalf can sign the [Individual
CLA](https://github.com/diem/diem/blob/main/documentation/contributing/individual-cla.pdf).
If you are contributing on behalf of your employer, please ask them to sign the
[Corporate
CLA](https://github.com/diem/diem/blob/main/documentation/contributing/corporate-cla.pdf).

## Issues

Diem uses [GitHub issues](https://github.com/diem/diem/issues) to track
Move uses [GitHub issues](https://github.com/move-language/move/issues) to track
bugs. Please include necessary information and instructions to reproduce your
issue.
4 changes: 1 addition & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Security Policies and Procedures

Please see Diem's
[security policies](https://developers.diem.com/docs/reference/security) and
procedures for reporting vulnerabilities.
Please do NOT report a security problem via GitHub issues. Instead, send a report to [email protected].
12 changes: 6 additions & 6 deletions docker/ci/github/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
FROM debian:buster-20211011@sha256:f9182ead292f45165f4a851e5ff98ea0800e172ccedce7d17764ffaae5ed4d6e AS setup_ci

RUN mkdir /diem
COPY rust-toolchain /diem/rust-toolchain
COPY scripts/dev_setup.sh /diem/scripts/dev_setup.sh
RUN mkdir /move
COPY rust-toolchain /move/rust-toolchain
COPY scripts/dev_setup.sh /move/scripts/dev_setup.sh

#this is the default home on docker images in gha, until it's not?
ENV HOME "/github/home"
Expand All @@ -14,7 +14,7 @@ ENV RUSTUP_HOME "/opt/rustup"
RUN mkdir -p /github/home && \
mkdir -p /opt/cargo/ && \
mkdir -p /opt/git/ && \
/diem/scripts/dev_setup.sh -t -b -p -y -d -n && \
/move/scripts/dev_setup.sh -t -b -p -y -d -n && \
apt-get clean && \
rm -rf /var/lib/apt/lists/*

Expand All @@ -37,12 +37,12 @@ RUN [ -x "$(set -x; command -v rustup)" ] \
&& [ -x "$(set -x; command -v solc)" ] \
&& [ -x "$(set -x; command -v z3)" ] \
&& [ -x "$(set -x; command -v "$BOOGIE_EXE")" ] \
&& [ -x "$(set -x; xargs rustup which cargo --toolchain < /diem/rust-toolchain )" ] \
&& [ -x "$(set -x; xargs rustup which cargo --toolchain < /move/rust-toolchain )" ] \
&& [ -x "$(set -x; command -v clang)" ] \
&& [ -x "$(set -x; command -v npm)" ]

# should be a no-op
# sccache builds fine, but is not executable ??? in alpine, ends up being recompiled. Wierd.
RUN /diem/scripts/dev_setup.sh -t -y -d -b -p
RUN /move/scripts/dev_setup.sh -t -y -d -b -p

FROM setup_ci as build_environment
4 changes: 1 addition & 3 deletions language/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Move Version 1.5

Version 1.5 of Move (released along with Diem Core version 1.5) includes a new package
system, a number of bug fixes,
and other improvements.
Version 1.5 of Move includes a new package system, a number of bug fixes, and other improvements.

## Highlights

Expand Down
4 changes: 2 additions & 2 deletions scripts/cargo_update_outdated.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

# It requires cargo-edit and cargo-outdated
# Example usage:
# diem$ ./scripts/cargo_update_outdated.sh
# diem$ git commit --all -m "Update dependencies"
# move$ ./scripts/cargo_update_outdated.sh
# move$ git commit --all -m "Update dependencies"
set -e

# check install for outdated & edit
Expand Down
6 changes: 3 additions & 3 deletions scripts/dev_setup.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
# Copyright (c) The Diem Core Contributors
# SPDX-License-Identifier: Apache-2.0
# This script sets up the environment for the Diem build by installing necessary dependencies.
# This script sets up the environment for the Move build by installing necessary dependencies.
#
# Usage ./dev_setup.sh <options>
# v - verbose, print all statements
Expand All @@ -25,7 +25,7 @@ cd "$SCRIPT_PATH/.." || exit

function usage {
echo "Usage:"
echo "Installs or updates necessary dev tools for diem/diem."
echo "Installs or updates necessary dev tools for Move."
echo "-b batch mode, no user interactions and miminal output"
echo "-p update ${HOME}/.profile"
echo "-t install build tools"
Expand Down Expand Up @@ -481,7 +481,7 @@ if [[ "$INSTALL_BUILD_TOOLS" == "false" ]] && \
fi

if [ ! -f rust-toolchain ]; then
echo "Unknown location. Please run this from the diem repository. Abort."
echo "Unknown location. Please run this from the move repository. Abort."
exit 1
fi

Expand Down
Loading

0 comments on commit 8625c74

Please sign in to comment.