Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and rename CONTRIBUTING.md to doc/src/contribute/index.md #782

Merged
merged 4 commits into from
Mar 12, 2022
Merged

Update and rename CONTRIBUTING.md to doc/src/contribute/index.md #782

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a33f04
Update and rename CONTRIBUTING.md to doc/src/contribute/index.md
Clay-Mysten Mar 11, 2022
ea8799c
Update index.md
Clay-Mysten Mar 11, 2022
5406be6
Update index.md
Clay-Mysten Mar 11, 2022
05438f6
Update index.md
Clay-Mysten Mar 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions CONTRIBUTING.md → doc/src/contribute/index.md
View file
Open in desktop
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).