amber/CONTRIBUTING.md

TL;DR: Setup your Amber clone

Amber repository contains more parts:

1. Amber language itself (in root directory). This is released.
2. Amber development helpers and CLI tool (in external/ subdirectories). Not part of release.
3. In internal/ directory, there are development files (index.html and its friends). Not part of release.
4. A place for other modules cloned in parallel with Amber (my)[1]. Not part of release. Not pushed to git.

To get your clone, follow this list:

1. Create a fork of the repository on GitHub
2. Clone the fork and go to its directory.
3. Install the tools: npm install -g amber-cli grunt-cli bower.
4. Run npm install to install dependencies listed in package.json. Used by development tools. See here for more info.
5. Run bower install to install dependencies listed in bower.json. Used by Amber in browser. See here for more info.
6. Run cd external/amber-dev && npm install && cd ../.. to install dependencies of amber-dev component.
7. Get your copy of Helios IDE into directory my/helios, choosing among using your own fork / using the stock version:
   • git clone git@github.com:<your username>/helios.git my/helios to use your own fork, or
   • git clone git@github.com:amber-smalltalk/helios.git my/helios to use stock version.
8. Install Helios' dependencies: cd my/helios && bower install && cd ../...
9. Get your copy of legacy IDE into directory my/amber-contrib-legacy: git clone git@github.com:amber-smalltalk/amber-contrib-legacy.git my/amber-contrib-legacy.
10. Run grunt devel. Prepares some transient files.
11. Run amber serve. Starts the integrated development server.

Now you should be able to start Amber devlopment page at http://localhost:4000/internal/ and commit changes you do to disk.

[1] Directory my is in .gitignore, so it is not present after clone, but because of being in .gitignore, it is "safe haven" to clone other repos into. Created especially for being able to have your fork of Amber in parallel with either you fork of Helios, to develop it in parallel, or with stock repo, just to use it.

Start Contributing by talking about Amber

• Talk to us on the gitter.im room
• Join our Mailinglist/Google Group
• Follow @AmberSmalltalk on Twitter
• Circle Amber Smalltalk on Google+
• Talk to us on the #amber-lang IRC channel

Filing Issues

If you think Amber is not working as expected, You can start by asking on gitter room, IRC or the Mailinglist. Please make sure that you have first checked the following guides:

TODO update these

• Getting Started
• Writing My First App
• How To Load Amber
• Amber FAQ

If the issue can not be resolved you should file an issue on the respective tracker.

Before reporting an issue, try to reduce the issue to the bare minimum required to reproduce it. This allows us to track down and fix the issue in an easier and faster way.

Additionally, you should give us enough information to reproduce the issue. Therefore, include versions of your OS, Amber, Node.js, Grunt, and possibly used libraries as well as sample code. If you don't list the exact steps required to reproduce the issue we won't be able to fix it.

Afterwards, report the issue on one of the following trackers:

• Amber Issues
• Helios IDE Issues
• Amber Examples Issues
• Amber Website Issues

Developing Amber

If you want to get started developing Amber itself there are a few links to get you started

• The Roadmap gives a rough idea about where Amber is heading towards
• The Contributions Page contains some ideas which we would love to integrate into Amber
• The Amber FAQ contains Answers to commonly arising questions
• The Amber CookBook contains recipies about working with Amber and its IDE
• The Amber Porting Guide contains information about porting code from other Smalltalk dialects
• The Amber JavaScript Guide contains information about how Amber and JavaScript are mapped to each other

If you want to get serious with Amber development you should read the Coding Conventions and check if you have all development dependencies installed (as indicated in Getting Started):

• Git (to get a clone of the repository, use Git for Windows in Windows)
• Node.js (to run the Amber development server)
• NPM (to install required Node.js packages)
• Bower (to install required client side libraries)
• Grunt-Cli (to compile Amber on the commandline)

Creating a Pull Request

The Amber development model currently revolves around Pull Requests which are created through GitHub

1. Update to latest Amber master (git pull)
2. Develop your feature or bugfix in a local branch (not in master)
3. Create unittest for your feature or bugfix (your feature/fix will be integrated a lot faster if unittests are present)
4. Enhance/fix Amber
5. Run the unittests
6. Commit your changes to disk if all tests are green
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)
8. If you created / deleted / moved API, update API-CHANGES.txt appropriately and commit.
9. Push the changes to your fork on GitHub git push <your repo> <your branchname>
10. Submit Pull Request (usually for the Amber master branch)

Compiling Amber with Grunt

Amber uses Grunt.js as build system since version 0.10.0 (in case of Windows issues check the Grunt.js on Windows).

If you created your clone according to the "Setting up your Amber clone", you should run

grunt

in Amber directory to start building from CLI.