Browse Source

CONTRIBUTING: some updates

Herbert Vojčík 1 month ago
parent
commit
735d9a4b41
1 changed files with 10 additions and 18 deletions
  1. 10 18
      CONTRIBUTING.md

+ 10 - 18
CONTRIBUTING.md

@@ -1,4 +1,4 @@
1
-TL;DR: Setup your Amber clone
1
+Setup your Amber clone
2 2
 ====
3 3
 
4 4
 Amber repository contains more parts:
@@ -10,11 +10,10 @@ Amber repository contains more parts:
10 10
 
11 11
 To get your clone, follow this list:
12 12
 
13
-1. Create a fork of the repository on GitHub
13
+1. Create a fork of the repository on lolg.it (create account first if you don't have one).
14 14
 1. Clone the fork and go to its directory.
15 15
 1. Install the tools: ```npm install -g amber-cli```.
16 16
 1. Run ```npm install``` to install dependencies listed in package.json. Used by development tools. See [here](https://www.npmjs.org/doc/cli/npm-install.html) for more info.
17
-1. Run ```bower install``` to install dependencies listed in bower.json. Used by Amber in browser. See [here](http://bower.io/) for more info.
18 17
 1. Run ```cd external/amber-dev && npm install && cd ../..``` to install dependencies of `amber-dev` component.
19 18
 1. Get your copy of Helios IDE into directory `my/helios`, choosing among using your own fork / using the stock version:
20 19
     - ```git clone git@lolg.it:<your username>/helios.git my/helios``` to use your own fork, or
@@ -35,11 +34,9 @@ either you fork of Helios, to develop it in parallel, or with stock repo, just t
35 34
 Start Contributing by talking about Amber
36 35
 =========================================
37 36
 
38
-* Talk to us on [the gitter.im room](https://gitter.im/amber-smalltalk/amber)
37
+* Join us on amber-lang slack channel. Request invitation on herby-mailbox-sk.
39 38
 * Join our [Mailinglist/Google Group](http://groups.google.com/group/amber-lang)
40 39
 * Follow [@AmberSmalltalk](https://twitter.com/AmberSmalltalk) on Twitter
41
-* Circle Amber Smalltalk on [Google+](https://plus.google.com/u/0/107038882958653788078)
42
-* Talk to us on [the #amber-lang IRC channel](irc://irc.freenode.net/amber-lang)
43 40
 
44 41
 
45 42
 Filing Issues
@@ -48,11 +45,8 @@ Filing Issues
48 45
 If you think Amber is not working as expected, You can start by asking on gitter room, IRC or the Mailinglist.
49 46
 Please make sure that you have first checked the following guides:
50 47
 
51
-**TODO** update these
52
-* [Getting Started](https://github.com/amber-smalltalk/amber/wiki/Getting-started)
53
-* [Writing My First App](https://github.com/amber-smalltalk/amber/wiki/Writing-my-first-app)
54
-* [How To Load Amber](https://github.com/amber-smalltalk/amber/wiki/How-to-load-amber)
55
-* [Amber FAQ](https://github.com/amber-smalltalk/amber/wiki/FAQ)
48
+* Getting Started (TBD, if you want to help, contribute to https://lolg.it/amber/amber-documentation.git)
49
+* [Amber FAQ](https://github.com/amber-smalltalk/amber/wiki/FAQ) Old, but something still holds.
56 50
 
57 51
 If the issue can not be resolved you should file an issue on the respective tracker.
58 52
 
@@ -76,26 +70,24 @@ Developing Amber
76 70
 
77 71
 If you want to get started developing Amber itself there are a few links to get you started
78 72
 
79
-* [The Roadmap](https://github.com/amber-smalltalk/amber/wiki/Roadmap) gives a rough idea about where Amber is heading towards
80
-* [The Contributions Page](https://github.com/amber-smalltalk/amber/wiki/Contributions) contains some ideas which we would love to integrate into Amber
81
-* [The Amber FAQ](https://github.com/amber-smalltalk/amber/wiki/FAQ) contains Answers to commonly arising questions
73
+* [The Amber FAQ](https://github.com/amber-smalltalk/amber/wiki/FAQ) contains Answers to commonly arising questions; old
82 74
 * [The Amber CookBook](https://github.com/amber-smalltalk/amber/wiki/Amber-cookbook) contains recipies about working with Amber and its IDE
83 75
 * [The Amber Porting Guide](https://github.com/amber-smalltalk/amber/wiki/Porting-code-from-other-Smalltalk-dialects) contains information about porting code from other Smalltalk dialects
84 76
 * [The Amber JavaScript Guide](https://github.com/amber-smalltalk/amber/wiki/From-smalltalk-to-javascript-and-back) contains information about how Amber and JavaScript are mapped to each other
85 77
 
86 78
 If you want to get serious with Amber development you should read the [Coding Conventions](https://github.com/amber-smalltalk/amber/wiki/Coding-conventions)
87
-and check if you have all development dependencies installed (as indicated in [Getting Started](https://github.com/amber-smalltalk/amber/wiki/Getting-started)):
79
+and check if you have all development dependencies installed (as indicated in README):
88 80
 
89 81
 * Git (to get a clone of the repository, use Git for Windows in Windows)
90 82
 * Node.js (to run the Amber development server)
91
-* NPM (to install required Node.js packages)
83
+* NPM (to install required Node.js packages, in most of setups included with Node.js)
92 84
 * Bower (to install required client side libraries)
93 85
 * Grunt-Cli (to compile Amber on the commandline)
94 86
 
95 87
 Creating a Pull Request
96 88
 -----------------------
97 89
 
98
-The Amber development model currently revolves around Pull Requests which are created through GitHub
90
+The Amber development model currently revolves around Pull Requests
99 91
 
100 92
 1. Update to latest Amber master (```git pull```)
101 93
 2. Develop your feature or bugfix in a local branch (not in ```master```)
@@ -105,7 +97,7 @@ The Amber development model currently revolves around Pull Requests which are cr
105 97
 6. Commit your changes to disk if all tests are green
106 98
 7. Try to split your fix into small Git commits if multiple changes are involved (this makes it easier for us to review the changes)
107 99
 8. If you created / deleted / moved API, update API-CHANGES.txt appropriately and commit.
108
-8. Push the changes to your fork on GitHub ```git push <your repo> <your branchname>```
100
+8. Push the changes to your fork on lolg.it ```git push <your repo> <your branchname>```
109 101
 9. Submit Pull Request (usually for the Amber master branch)
110 102
 
111 103