From c3f7c73d7a6b4f9c8ca4543721f8acc29a5e59b4 Mon Sep 17 00:00:00 2001 From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com> Date: Sat, 12 Mar 2022 11:44:49 -0800 Subject: [PATCH] Update and rename CONTRIBUTING.md to doc/src/contribute/index.md (#782) * Update and rename CONTRIBUTING.md to doc/src/contribute/index.md Repurpose existing CONTRIBUTING page as the Contribute section landing page Add sub- and related pages to bottom for further reading * Update index.md Fix title entry * Update index.md Fix white paper link * Update index.md Moving Logging to Contribute --- .../src/contribute/index.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) rename CONTRIBUTING.md => doc/src/contribute/index.md (52%) diff --git a/CONTRIBUTING.md b/doc/src/contribute/index.md similarity index 52% rename from CONTRIBUTING.md rename to doc/src/contribute/index.md index 3f45503ae4b23..48ef2253977ff 100644 --- a/CONTRIBUTING.md +++ b/doc/src/contribute/index.md @@ -1,6 +1,6 @@ -## Contributing to Sui - -TODO: Define basic system requirements for a reliable environment: recommended OS and required packages. +--- +title: Contributing to Sui +--- To contribute, ensure you have the latest version of the codebase. To clone the repository, run the following: ```bash @@ -9,12 +9,6 @@ cd sui cargo build --all --all-targets cargo test ``` -TODO: Note the `git clone` command above may fail with the following error, which *should* go away when we open our repo up: - -``` -remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead. -remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information. -``` ## Pull requests @@ -28,4 +22,10 @@ To submit your pull request: 6. Complete the Contributor License Agreement (CLA), if you haven't already done so. 7. Submit your pull request. -TODO: Add links to the steps above for more details, such as how to build and test the dev site and where to find the CLA once we have one. +## Further reading + +* Learn [about Mysten Labs](https://mystenlabs.com/) the company on our public site. +* Read the [Sui Smart Contract Platform](../../paper/sui.pdf) white paper. +* * Implementing [logging](observability.md) in Sui to observe the behavior of your development. +* Find related [research papers](research-papers.md). +* See and adhere to our [code of conduct](code-of-conduct.md).