5157c40 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

link out to gh docs

5157c40Gemma Shay4 years ago

README.md+2−39

@@ -1,4 +1,4 @@

1−The website for Urbit is maintained by [Tlon](https://tlon.io) and the Urbit community. Issues and contributions are welcome.

1+The website for Urbit is maintained by the Urbit Foundation and the Urbit community. Issues and contributions are welcome.

3## Getting Started

@@ -30,44 +30,7 @@ The website for Urbit is maintained by [Tlon](https://tlon.io) and the Urbit com

31 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

33−## Contributing

33+To learn more about contributing, see GitHub's [documentation](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).

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.

72## Framework and Library Documentation

35## Framework and Library Documentation