Skip to content

Commit

Permalink
Update and rename CONTRIBUTING.md to doc/src/contribute/index.md (Mys…
Browse files Browse the repository at this point in the history
…tenLabs#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
  • Loading branch information
Clay-Mysten authored Mar 12, 2022
1 parent 6365eaa commit c3f7c73
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md → doc/src/contribute/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand All @@ -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).

0 comments on commit c3f7c73

Please sign in to comment.