Skip to content

Instantly share code, notes, and snippets.

@jsebrech
Last active April 13, 2018 13:06
Show Gist options
  • Save jsebrech/2c3fe357d46adab772511d44b66307c3 to your computer and use it in GitHub Desktop.
Save jsebrech/2c3fe357d46adab772511d44b66307c3 to your computer and use it in GitHub Desktop.
Smart Widget CONTRIBUTING.md template

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.

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

  • The look and feel should match the Antwerp Core Branding guidelines.
  • 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.
  • All code should conform to the Angular style guide, as well as the ACPaaS UI guidelines.

How can I contribute code?

Building and Testing

...

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 …"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment