Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.45 KB

Contributing

There's several ways to contribute to the project: reporting bugs, sending feedback, proposing ideas for new features, fixing or adding documentation, promoting the project, or even contributing code.

Reporting issues

You can report issues here

Contributing Code

  • This project is MIT licensed, so any code contribution MUST be under the same license.
  • The source code is hosted in this repository using the Tonel format in the source folder.
  • The release-candidate branch contains the latest changes and should always be in a releasable state.
  • Feel free to send pull requests or fork the project.

Using Iceberg

  1. Download a Pharo Image and VM
  2. Clone the project or your fork using Iceberg
  3. Open the Working Copy and using the contextual menu select Metacello -> Install baseline (default)
  4. This will load the base code and the test cases
  5. Create a new branch to host your code changes
  6. Do the changes
  7. Commit and push your changes to the branch using the Iceberg UI
  8. Create a Pull Request against the release-candidate branch

Contributing documentation

The project documentation is maintained in this repository in the docs folder and licensed under CC BY-SA 4.0. To contribute some documentation or improve the existing, feel free to create a branch or fork this repository, make your changes and send a pull request.