Skip to content

Latest commit

 

History

History
74 lines (42 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

74 lines (42 loc) · 2.81 KB

Contribution Guidelines

First off, thanks for taking the time to contribute! 👍

I just have a question

You can launch a quick question on the #acpaas-ui slack channel.

For something that requires longer discussion it may be better to book an issue.

How do I report bugs / ask features?

Please book a GitHub issue.

What should I know to get started?

This widget is part of the ACPaaS UI platform. For more info about Smart Widgets, check the documentation hub.

Before contributing code, you should be aware of the following:

  • The architecture consists of a separate front-end and back-end package. The back-end is a so-called Backend-For-Frontend (BFF). The architecture should conform to the SA2020 guidelines.
  • There may be multiple independent front-ends and back-ends for the different technologies that Digipolis supports. All of these should implement the same BFF API. The set of supported technologies is described in the DAAS standard.

How can I contribute code?

Code layout

  • ./src contains the service library (typescript)
  • ./example contains the demo app (typescript)
  • ./testcontains the jasmine unit tests (javascript)

Building and Testing

> npm install

Commands:

  • Start the demo app

    > npm start

  • Run the tests (with coverage)

    > npm test

Submitting Changes

Please send us your changes as a GitHub pull request.

In order for us to be able to accept your pull request without remarks, please do these things:

  • Follow the above style guides.
  • Please update the readme documentation and example app along with the code.
  • Make sure all the tests pass.
  • Provide a clear description on the pull request of what was changed
  • Link to a relevant issue. Feel free to create one if none exists.

If possible, do provide meaningful and clean commit messages. A good commit message completes the sentence "When committed this will …"

Publishing

Only the ACPaaS UI team publishes new packages. Contact us if you need a new release published.

Follow these steps to publish a new version of the package. You must have a Digipolis account with access to Nexus.

  1. Increment the version in package.json

  2. Log in to the the private registry

    > npm login --registry=https://nexusrepo.antwerpen.be/repository/npm-private/

  3. Publish the package

    > npm publish --registry=https://nexusrepo.antwerpen.be/repository/npm-private/