Skip to content

Commit

Permalink
More Antwerp UI
Browse files Browse the repository at this point in the history
  • Loading branch information
TriangleJuice committed Jun 1, 2021
1 parent 949d050 commit 24810a5
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ members of the project's leadership.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
[homepage]: https://www.contributor-covenant.org
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Hi! We're really excited that you are interested in contributing to Antwerp UI. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

- [Antwerp UI Contributing Guide](#acpaas-ui-contributing-guide)
- [Antwerp UI Contributing Guide](#antwerp-ui-contributing-guide)
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
Expand All @@ -14,7 +14,7 @@ Hi! We're really excited that you are interested in contributing to Antwerp UI.
## Issue Reporting Guidelines

- If you're not yet a member of our DigAnt Café slack community, you can easily [join here][digantcafe-slack].
- Use the [#acpaas-ui-react channel][acpaas-ui-react-slack] on slack to ask questions or discuss changes to the code itself.
- Use the [#antwerp-ui-react channel][antwerp-ui-react-slack] on slack to ask questions or discuss changes to the code itself.
- Use [GitHub Issues][github-issues] to report bugs, request features, ask policy questions or propose policy changes.

> Note: policy questions are about the way Antwerp UI is developed and released, or about its architecture. We use github issues to have a public archive of these discussions.
Expand All @@ -34,10 +34,10 @@ Hi! We're really excited that you are interested in contributing to Antwerp UI.

- If adding a new feature:
- Add an accompanying test case.
- Provide a convincing reason to add this feature. Ideally you should open a [feature request issue](https://github.com/digipolisantwerp/acpaas-ui_react/issues/new?template=feature_request.md) first and have it greenlighted before working on it.
- Provide a convincing reason to add this feature. Ideally you should open a [feature request issue](https://github.com/digipolisantwerp/antwerp-ui_react/issues/new?template=feature_request.md) first and have it greenlighted before working on it.

- If fixing a bug:
- Provide a detailed description of the bug in the PR or an accompanying [bug report issue](https://github.com/digipolisantwerp/acpaas-ui_react/issues/new?template=bug_report.md) linked from the PR (recommended).
- Provide a detailed description of the bug in the PR or an accompanying [bug report issue](https://github.com/digipolisantwerp/antwerp-ui_react/issues/new?template=bug_report.md) linked from the PR (recommended).
- Add appropriate test coverage if applicable.

## Development Setup
Expand Down Expand Up @@ -76,11 +76,11 @@ The default test script will do the following: lint with ESLint -> unit tests wi

## Releases

Antwerp UI is supplied as a single library on NPM [@acpaas-ui/react-components](https://www.npmjs.com/package/@acpaas-ui/react-components).
Antwerp UI is supplied as a single library on NPM [@antwerp-ui/react-components](https://www.npmjs.com/package/@antwerp-ui/react-components).

It is released once a week, or more often if there are high priority changes.

If your PR has been merged but not yet released, and it is high priority, please ping the [#acpaas-ui-react channel][acpaas-ui-react-slack] to ask for an out-of-band release (if you're not yet a member of our DigAnt Café slack community, you can easily [join here][digantcafe-slack]). However, before you do so, container whether you can use a [local install or the npm link command](https://medium.com/@the1mills/how-to-test-your-npm-module-without-publishing-it-every-5-minutes-1c4cb4b369be) instead, or whether you can publish your own development snapshot package under your personal scope on NPM.
If your PR has been merged but not yet released, and it is high priority, please ping the [#antwerp-ui-react channel][antwerp-ui-react-slack] to ask for an out-of-band release (if you're not yet a member of our DigAnt Café slack community, you can easily [join here][digantcafe-slack]). However, before you do so, container whether you can use a [local install or the npm link command](https://medium.com/@the1mills/how-to-test-your-npm-module-without-publishing-it-every-5-minutes-1c4cb4b369be) instead, or whether you can publish your own development snapshot package under your personal scope on NPM.

A [changelog](CHANGELOG.md) is provided for your convenience.

Expand All @@ -90,6 +90,6 @@ A [changelog](CHANGELOG.md) is provided for your convenience.

Thank you to all the people who have already contributed to Antwerp UI!

[github-issues]: https://github.com/digipolisantwerp/acpaas-ui_react/issues
[acpaas-ui-react-slack]: https://digantcafe.slack.com/messages/CDGCW8U30/
[github-issues]: https://github.com/digipolisantwerp/antwerp-ui_react/issues
[antwerp-ui-react-slack]: https://digantcafe.slack.com/messages/CDGCW8U30/
[digantcafe-slack]: https://digantcafe-slack.digipolis.be
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ Antwerp City Platform as a Service User Interface (Antwerp UI) is a **component

## Ecosystem

This library is part of [Antwerp UI][acpaas-ui].
This library is part of [Antwerp UI][antwerp-ui].

| Name | Framework | Status |
| ----------------- | ---------- | ------- |
| Schematics | ES5+ | [![acpaas-ui-schematics-github]][acpaas-ui-schematics] |
| Javascript | ES5+ | [![acpaas-ui-js-github]][acpaas-ui-js] |
| Angular | Angular 6+ | [![acpaas-ui-angular-github]][acpaas-ui-angular] |
| React | React 16+ | [![acpaas-ui-react-github]][acpaas-ui-react] |
| Javascript | ES5+ | [![antwerp-ui-js-github]][antwerp-ui-js] |
| Angular | Angular 6+ | [![antwerp-ui-angular-github]][antwerp-ui-angular] |
| React | React 16+ | [![antwerp-ui-react-github]][antwerp-ui-react] |

## Getting Started

Expand All @@ -37,13 +36,13 @@ Note that you are free to use your own grid, as long as it meets our branding gu

> To learn more about using the branding look & feel, check the [core branding guide][branding-core-guide]. Note that the [core branding][branding-core] contains the Antwerp logo and fonts, which are subject to a usage restriction. For use outside of apps for the city of Antwerp you can use [acpaas branding][branding-acpaas] instead.
Check out the [live examples and API docs](https://digipolisantwerp.github.io/acpaas-ui_react/) to learn more.
Check out the [live examples and API docs](https://digipolisantwerp.github.io/antwerp-ui_react/) to learn more.

## Questions

For questions and support please ask a question on the [#acpaas-ui-react slack channel][acpaas-ui-react-slack]. If you're not yet a member of our DigAnt Café slack community, you can easily [join here][digantcafe-slack].
For questions and support please ask a question on the [#antwerp-ui-react slack channel][antwerp-ui-react-slack]. If you're not yet a member of our DigAnt Café slack community, you can easily [join here][digantcafe-slack].

If you stumble across a bug or missing feature, feel free to [report an issue][acpaas-ui-react-issues]. Please fill out the issue template completely when [opening an issue][acpaas-ui-react-issues]. This will help us get to your issue sooner.
If you stumble across a bug or missing feature, feel free to [report an issue][antwerp-ui-react-issues]. Please fill out the issue template completely when [opening an issue][antwerp-ui-react-issues]. This will help us get to your issue sooner.

## Changelog

Expand All @@ -53,7 +52,7 @@ Detailed changes for each release are documented in the [changelog](./CHANGELOG.

Your contributions are most welcome as pull requests, both code changes and documentation updates. However, to keep a high quality standard, please make sure to read the [Contributing Guide](./CONTRIBUTING.md) before making a pull request.

Thank you to all the people [who already contributed][acpaas-ui-react-contributors] to Antwerp UI!
Thank you to all the people [who already contributed][antwerp-ui-react-contributors] to Antwerp UI!

## Support

Expand All @@ -66,26 +65,24 @@ Jasper Van Proeyen (<[email protected]>)
Copyright (c) 2018-present, Digipolis

<!-- Generic Links -->
[acpaas-ui]: https://acpaas-ui.digipolis.be
[acpaas-ui-react-slack]: https://digantcafe.slack.com/messages/CDGCW8U30/
[antwerp-ui]: https://antwerp-ui.digipolis.be
[antwerp-ui-react-slack]: https://digantcafe.slack.com/messages/CDGCW8U30/
[flexboxgrid]: https://github.com/a-ui/core_flexboxgrid_scss
[digantcafe-slack]: https://digantcafe-slack.digipolis.be

<!-- Github links -->

<!-- Github URL -->
[acpaas-ui-schematics]: https://github.com/digipolisantwerp/acpaas-ui_schematics
[acpaas-ui-js]: https://github.com/digipolisantwerp/acpaas-ui_js
[acpaas-ui-angular]: https://github.com/digipolisantwerp/acpaas-ui_angular
[acpaas-ui-react]: https://github.com/digipolisantwerp/acpaas-ui_react
[acpaas-ui-react-issues]: https://github.com/digipolisantwerp/acpaas-ui_react/issues
[acpaas-ui-react-contributors]: https://github.com/digipolisantwerp/acpaas-ui_react/graphs/contributors
[antwerp-ui-js]: https://github.com/digipolisantwerp/acpaas-ui_js
[antwerp-ui-angular]: https://github.com/digipolisantwerp/acpaas-ui_angular
[antwerp-ui-react]: https://github.com/digipolisantwerp/acpaas-ui_react
[antwerp-ui-react-issues]: https://github.com/digipolisantwerp/acpaas-ui_react/issues
[antwerp-ui-react-contributors]: https://github.com/digipolisantwerp/acpaas-ui_react/graphs/contributors
[branding-core]: https://github.com/a-ui/core_branding_scss
[branding-core-guide]: https://a-ui.github.io/core_branding_scss/
[branding-acpaas]: https://github.com/a-ui/acpaas_branding_scss

<!-- Github Version Badge -->
[acpaas-ui-schematics-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_schematics.svg
[acpaas-ui-angular-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_angular.svg
[acpaas-ui-react-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_react.svg
[acpaas-ui-js-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_js.svg
[antwerp-ui-angular-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_angular.svg
[antwerp-ui-react-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_react.svg
[antwerp-ui-js-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_js.svg

0 comments on commit 24810a5

Please sign in to comment.