First off, thanks for taking the time to contribute! 👍
You can launch a quick question on the #acpaas-ui-ngx slack channel. If you're not yet a member of our DigAnt Café slack community, you can easily join here.
For something that requires longer discussion it may be better to book an issue.
Please book a GitHub issue.
This component is part of the ACPaaS UI platform.
Before contributing code, you should be aware of the following:
- All code should conform to the Angular style guide, as well as the ACPaaS UI guidelines.
./srccontains the component and decorator source./examplecontains the demo app
> npm install
Commands:
-
Start the demo app
> npm start -
Run the tests (continously)
> npm run test-watchCode coverage reports are output to the
./coveragefolder. -
Lint and test (once)
> npm test
This repo is based on the Angular Library Starter Kit. See its documentation for more details (such as how to write tests).
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 …"
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 be a member of the @acpaas-ui organization on NPM.
-
Increment the version in package.json
-
Log in to the npmjs registry
> npm login -
Publish the package
> npm run build > npm publish dist