Skip to content

Commit

Permalink
docs: import latest docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasm0 committed Dec 5, 2024
1 parent 647e782 commit 1499943
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 19 deletions.
9 changes: 5 additions & 4 deletions docs/frontend/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,15 @@ The law is applicable to all government websites and applications, including int
- [ ] Apply the provided CSS snippet and confirm that all elements are still rendered correctly, adhering to WCAG 1.4.12. In Chrome, you can utilize the Stylus plugin for easy implementation.

```css
*{
* {
line-height: 1.5 !important;
letter-spacing: 0.12em !important;
word-spacing: 0.16em !important;
} p
{
}

p {
margin-bottom: 2em !important;
}
}
```

### on a mobile app?
Expand Down
6 changes: 3 additions & 3 deletions docs/frontend/languages-and-frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ For all frontend projects within the Municipality of Amsterdam we work with [NPM

## React Frameworks

- [next](https://nextjs.org/) - Full stack React Framework build on top of Node JS.
- [remix](https://remix.run/) - Full stack React Framework using the WEB API.
- [Next.js](https://nextjs.org/) - Full stack React Framework build on top of Node JS.
- [Remix](https://remix.run/) - Full stack React Framework using the WEB API.

## CSS

_To Be Defined_
- [CSS Modules](https://github.com/css-modules/css-modules)
2 changes: 1 addition & 1 deletion docs/frontend/shared-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Amsterdam has developed a couple of components that are being used

## Demos/examples

- For developing with maps, there are demos and examples of common use-cases of maps at [https://maps.developers.amsterdam](https://maps.developers.amsterdam).
- For developing with maps, there are demos and examples of common use-cases of maps at [maps.developers.amsterdam](https://maps.developers.amsterdam).
3 changes: 2 additions & 1 deletion docs/frontend/third-party-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,6 @@ Maintaining a list of third-party frontend packages is too complex, therefore, w

* [Vite](https://github.com/vitejs/vite) - Next Generation Frontend Tooling
* [Vite community templates](https://github.com/vitejs/awesome-vite#templates) - Vite based project templates
* [Webpack](https://github.com/vitejs/vite) - Next Generation Frontend Tooling
* [esbuild](https://esbuild.github.io/) - Next Generation Frontend Tooling

You may also be interested in [Languages and Frameworks (frontend)](./languages-and-frameworks.md).
19 changes: 9 additions & 10 deletions docs/general/using-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@
## What is the standard for using Git?
The city of Amsterdam uses Git to push its code to GitHub.
The city of Amsterdam maintains minimal requirements for the work flow, branches and commits.
The city of Amsterdam maintains minimal requirements for the work flow, branches and commits.

## When and for whom is this standard applicable?
This standard applies to all developers.<br/>
This standard must be applied to all new projects of the city of Amsterdam (new since June 2024).

## What is required?
### Work flow
- [ ] Utilise the branch 'main' as a stable production-ready version of your project. Utilise the branch 'develop' as the integration branch for features and bug fixes.
- [ ] Utilise the branch `main` as a stable production-ready version of your project. Utilise the branch `develop` as the integration branch for features and bug fixes.
- [ ] Set up and document your team work flow. As part of your work flow you must do the following:
- [ ] Set `develop` as the default branch and set the branch protection rules as follows:
- [ ] Enable "Require a pull request before merging".
- [ ] Enable "Require approvals".
- [ ] Set "Required number of approvals before merging" to at least 1.
- [ ] Set "Required number of approvals before merging" to at least 1.
- [ ] Create a new branch every time you're implementing a feature, bug fix or other task.
- [ ] Test before you push.

### Branches
- [ ] Branch names must include
- [ ] a prefix, which can be either:
- [ ] feature,
- [ ] chore,
- [ ] bugfix,
- [ ] hotfix or
- [ ] docs.
- [ ] a prefix, which can be either:
- [ ] `feature/branch-name`
- [ ] `chore/branch-name`
- [ ] `bugfix/branch-name`
- [ ] `hotfix/branch-name`
- [ ] `docs/branch-name`
- [ ] a ticket number that references the PBI (product backlog item) if applicable.
- [ ] a short name to indicate the branch purpose.

Expand Down Expand Up @@ -58,4 +58,3 @@ please refer to this [blog post](https://initialcommit.com/blog/git-commit-messa

## Acknowledgements
Many thanks to [Hee Chan van der Haar](https://github.com/hcvdhaar) and [Sirée Koolen-Wijkstra](https://github.com/SireeKoolenWijkstra)

0 comments on commit 1499943

Please sign in to comment.