git.iko.soy/urbit.org
on master help sign in
contribution instructions and clarifications
636ba8fGemma Shay
README.md+63−14
compare with master
unifiedsplit
@@ -1,24 +1,73 @@
1−The website for Urbit.
1+The website for Urbit is maintained by [Tlon](https://tlon.io) and the Urbit community. Issues and contributions are welcome.
2
2
3## Getting Started
3## Getting Started
4
4
5−Install Node 14. [nvm](https://github.com/nvm-sh/nvm) should handle this by running `nvm install 14`, then `nvm use` whenever in the repository (or automate it with a script - see [here](https://github.com/nvm-sh/nvm#deeper-shell-integration)).
5+1. Fork the [Urbit site repository](https://github.com/urbit/urbit.org).
6
6
7−Install our dependencies:
7+2. [Create a local clone](https://help.github.com/articles/cloning-a-repository/) of your fork.
8
8
9−```bash
9+3. Navigate to the `urbit.org` directory and install Node 14 using [nvm](https://github.com/nvm-sh/nvm):
10−npm install
11−```
12
10
13−Run the development server:
11+ ```shell
12+ cd urbit.org
13+ nvm install 14
14+ ```
15+ You can then run `nvm use` whenever in the repository (or automate it with a script - see [here](https://github.com/nvm-sh/nvm#deeper-shell-integration)).
14
16
15−```bash
17+4. Install our dependencies:
16−npm run dev
17−# or
18−yarn dev
19−```
20
18
19+ ```shell
20+ npm install
21+ ```
22+
23+5. Run the development server:
24+
25+ ```shell
26+ npm run dev
27+ # or
28+ yarn dev
29+ ```
30+
21−Finally, open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
31+ Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
32+
33+## Contributing
34+
35+Once you're ready to contribute:
36+
37+1. Create a new local branch for your work:
38+
39+ ``` shell
40+ cd urbit.org
41+ git checkout -b "<your branch name>"
42+ ```
43+
44+2. Make your changes in the text editor of your choice (e.g., [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/)).
45+
46+3. Stage your changes for commit:
47+
48+ ```
49+ git add <filename>
50+ ```
51+
52+4. Commit your changes:
53+
54+ ```
55+ git commit -m "<concise message describing changes>"
56+ ```
57+
58+5. Run the development server to view your local changes in your browser at [http://localhost:3000](http://localhost:3000).
59+
60+ ```shell
61+ npm run dev
62+ # or
63+ yarn dev
64+ ```
65+
66+6. [Push your local branch to the remote repo](https://help.github.com/articles/pushing-to-a-remote/).
67+
68+7. Back in the urbit.org repo in the GitHub UI, [open a pull request](https://github.com/urbit/urbit.org/pulls).
69+
70+Once your changes have been reviewed and any necessary edits have been made, you'll be able to merge your pull request.
22
71
23## Framework and Library Documentation
72## Framework and Library Documentation
24
73
@@ -37,4 +86,4 @@ We deploy using Vercel. All pull requests will show a deployment preview via the
37
86
38## Upgrades
87## Upgrades
39
88
40−The `/scripts` contains scripts used to programmatically upgrade site content data.
89+The `/scripts` contains scripts used to programmatically upgrade site content data.