Skip to content

Latest commit

 

History

History
89 lines (40 loc) · 4.65 KB

CONTRIBUTING.md

File metadata and controls

89 lines (40 loc) · 4.65 KB
Raw

How to contribute to Modality

Thank you so much for your wish to contribute to Modality! There are many areas where help is needed, and we have listed some suggestions below, but we are also open to your own suggestions.

Adding Javadoc

Modality is now starting to transition from the prototyping phase into MVP development, and the newly stable code is ready to benefit from comprehensive Javadoc.

  • If you would like to add useful Javadoc to the codebase, please fork Modality for this purpose, then raise a pull request for us to merge your changes into main.

Writing unit tests

We are now in a position to start writing new and retrospective tests for Modality, and have incorporated the JUnit and Mockito test frameworks into the codebase.

  • If you would like to write new (or modify existing) JUnit tests, you could fork Modality for this purpose, then raise a pull request for us to merge your changes into main.

Developing integration tests

Large parts of Modality are already operational, principally in the Back-Office, which is organised according to activities (screens). The completed activities are ready to be subjected to automated integration testing, together with all newly created activities.

  • We will soon be incorporating an integration test framework into Modality, after which we will be happy to invite you to help us expand the integration test coverage.

Writing business layer code

The highest layer of the Modality architecture consists of business-specific modules implementing logic for events, hotels, restaurants etc. Code written here is usually directly represented on-screen.

  • If you would like to contribute business layer code, feel free to assign yourself to one of our GitHub issues.

Writing ecommerce layer code

The next layer down is the ecommerce layer. This provides a generic domain model for ecommerce, which models sales, accounts etc. It is the location for payment gateway integration and ecommerce-specific UIs.

  • If you would like to contribute ecommerce layer code, feel free to assign yourself to one of our GitHub issues.

Writing CRM layer code

The CRM layer provides the essential CRM features, including customer accounts, integrated mailing system etc.

  • If you would like to contribute CRM layer code, take a look at our GitHub issues.

Writing Base layer code

The Base layer is a fully operational implementation of the WebFX stack layer beneath, based on the Postgres database. This layer is a pure technical solution that isn’t bound to any specific domain.

  • If you would like to contribute base layer code, take a look at our GitHub issues.

Reporting bugs

  • We invite you to report any bugs found in Modality on our GitHub issues page.

Fixing bugs

If you find a bug, or would like to work on a previously-reported bug on our issues page, you could fork the Modality and try to fix it.

  • We are accepting pull requests should you wish to submit a bug fix from your fork.

Thank you so much for joining the Modality community!