Skip to content

docs: Document Environment Setup for Contributors (#515) #526

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

Open
orunganiekan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document Environment Setup for Contributors (#515) #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

Thank you for your interest in contributing to NotifyChain! This document provides guidelines and instructions for contributing to the project.

**Start here instead (recommended):** [`CONTRIBUTOR_DEVELOPMENT_WORKFLOW_GUIDE.md`](CONTRIBUTOR_DEVELOPMENT_WORKFLOW_GUIDE.md)
**Start here instead (recommended):**

- Environment setup (tools, clone, verify): [`docs/ENVIRONMENT_SETUP.md`](docs/ENVIRONMENT_SETUP.md)
- Development workflow (fork, branch, PR): [`CONTRIBUTOR_DEVELOPMENT_WORKFLOW_GUIDE.md`](CONTRIBUTOR_DEVELOPMENT_WORKFLOW_GUIDE.md)

## Code of Conduct

Expand All @@ -15,11 +18,12 @@ Thank you for your interest in contributing to NotifyChain! This document provid

### Prerequisites

To contribute to NotifyChain, make sure you have:
- [Rust](https://www.rust-lang.org/tools/install) installed with WebAssembly target (`rustup target add wasm32-unknown-unknown`)
- [Stellar CLI](https://developers.stellar.org/docs/build/sdks-and-libraries/cli/) installed
- [Node.js](https://nodejs.org/) (for listener and dashboard components)
- Basic understanding of Soroban smart contracts, Git, and GitHub
To contribute to NotifyChain, install the tools listed in
[`docs/ENVIRONMENT_SETUP.md`](docs/ENVIRONMENT_SETUP.md) (Rust, WebAssembly
target, Stellar CLI, Node.js 22, Git). The guide includes verification steps
to confirm your machine is ready.

You should also have a basic understanding of Soroban smart contracts, Git, and GitHub.

### Setup (Fork Workflow)

Expand Down
Loading
Loading