Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.68 KB

becomeacontributor.md

File metadata and controls

39 lines (29 loc) · 1.68 KB
Raw
layout title
default
Become a contributor

Become a contributor

If you want to become a contributor, you should start with usage page. You'll find some tools and configuration that helps you to start and setup your environment.

Before you start:

  • check existing repository and setup you dev environment before you start
  • make your proposal to add new macros/functionalities and use project to track it
  • think about new projects (especially if new proposal doesn't fit in existing one)
  • use always pull request
  • spread the word about this project (for new developer and new users)

Tools needed:

  • Git
  • GitHub account
  • Gradle
  • KickAssembler

Tools recommended:

  • Visual Studio Code (with KickAssembler 8-bit retro studio)

Main documentation:

  • Commodore 128 PROGRAMMER'S REFERENCE GUIDE [book]
  • Mapping the Commodore 128 [book]

How to contribute

There are many ways to contribute. You can act as a developer: there are existing project that can be improved, maintained (with refactor and bugfixing) or even created.

Ideas can be presented, discussed and implemented. GitHub provides a kanban board to assign tasks and monitor progress. Don't want to add too much stiffness, but some coordination is needed if you want to collaborate on an open source project with many people.

There is also an internal team where contributors can discuss about library.

But if you are not a developer or you prefer to contribute in any other way, you can still participate by writing the memory reference guide or library documentation.

Ok, beam me up!

If you want to be a contributor, please submit an issue.