Development

Introductory reading

Wollok is being developed on top of XText stack. So, if you are not familiar with it, maybe it would be a good start to take a look at the following links:

• Xtext Documentation
• Xtext Notes Written by the Chair (spanish)
• Xtext Notes Written by the Chair (english)
• Xtext in 5 minutes

Wollok Design

• Interpreter Design
• Natives Objects Implementation

Contribution workflow

We use standard open source practices with github.

If you don't have access to the repository then

1. Fork the repository
2. Create a feature branch for you to work
3. Commit changes and push the new branch to your repo. You may solve feature in Wollok or with native code
4. Then you should add some tests.
5. Once you think it is ok and passes all the tests then create a Pull Request (PR) to integrate that branch against our repository's dev branch. IMPORTANT: If you are solving an issue, please, name the branch & PR with a label "#xxxxx", where xxxxx is the number of github issue. For example: fix-#1013-removing-elements-of-collection-during-iteration.

If you have access to our repository then

1. Same as above but without the need to fork the repository.
2. Still use feature branches with PR

Useful sections (How-To's)

The following pages contain useful information for Wollok developers.

• Developer Environment Setup
• Developing a Wollok SDK Class: Contribute a class to the Wollok lib SDK
• Changing the Language: how to add a syntax element and change all parts of the language to intepret, check, run and test that element
• Testing: how to run wollok tests and how to write them.
• Adding a Template Proposals: how to add a template proposal (autocomplete) for a language element.
• Adding a New Static Validation: how to add a new static check/validation (warning / error)
• Adding a QuickFix that solves validation issues directly into the editor
• Changing outline view of Wollok objects
• Deploying Wollok: how to build & release Wollok products in a SCM environment