Skip to content

contributing.md

Latest commit

 

History

History
40 lines (26 loc) · 2.98 KB

contributing.md

File metadata and controls

40 lines (26 loc) · 2.98 KB

Contributing to Alkemio

Here you can find details of requirements for contributing to the project, an overview of key repositories as well as how coordination takes place.

Licensing

All contributors to the project are required to sign a Contributor License Agreement (CLA) to ensure that the contents of the repository are covered from a legal perspective. The CLA process is enforced for all contributions.

Repositories

The key repositories in use by the project are:

  • Coordination: This is the main repository for orchestrating the project.
  • Server: the primary back end server that manages interactions with the platform
  • Client.Web: browser based interface for interacting with the platfrom.
  • Demo: for createing a demonstration instance of the platform, with data, locally.
  • Client.Lib: wrapper around the server api for interacting programmatically with the platform.
  • Populator: for populating a Subspace Space using data loaded from a spreadsheet.
  • Notifications: a separate service that provides notification services, using out of band channels such as email.
  • Infrastructure: additional information related to deploying the platform as a cluster

Each repository itself contains documentation that is specific for that component.

Coordination

The coordination of this project is based primarily on GitHub issues, augmented by Zenhub for a more agile interface to the backlog.

Each repo has its own set of issues.

This repo is used for issues / discussions that span the whole project.

All Epics are in the Alkemio repo.

Our Roadmap is public, so you can see what Epics are being worked on / planned. Note: timelines are an indication, if you see a particular Epic that is important for you please reach out to discuss its prioritization and expected delivery timeline. All Epics are in the Alkemio repo.

If you are contributing to the project the default path is to fork and submit a pull request.

There is a private ZenHub board for active sprint planning (private due to Zenhub license model), if you want to get involved at that level then let's talk!

Finally and imporantly, there is a Building Alkemio Space on the platform; this is a great place to go and connect to the community behind Alkemio. It is also the place for discussions about ideas, needing help, collaborations etc.

Becoming a core contribrutor

If you are interested in becoming a core contributor then please reach out via community@alkem.io.