Skip to content

Commit

Permalink
docs: update checklist in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkoSagadin committed Mar 19, 2024
1 parent 5d2ed18 commit bc5bc91
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,46 @@ of CI workflows for release automation.

## Checklist

### General GitHub setup

- [ ] Provide a concise and accurate description of your project in the GitHub
"description" field.
- [ ] Provide a concise and accurate description of your project in this
`README.md` file, replace the title.
- [ ] Ensure that your project follows [repository naming scheme].
- [ ] Turn on `gitlint` tool by running `gitlint install-hook`. If you do not

### Tooling

- [ ] Turn on `pre-commit` tool by running `pre-commit install`. If you do not
have it yet, follow instructions
[here](https://github.com/IRNAS/irnas-guidelines-docs/tree/main/tools/gitlint).
[here](https://github.com/IRNAS/irnas-guidelines-docs/tree/main/tools/pre-commit).

### Zephyr specifics

- [ ] Select the version of NCS in the `west.yaml` file, check the below section
for specifics.
- [ ] Provide repository setup instructions, use template in _Setup_ section
below. Replace `<repo-name>`, `<board_name>`, and `<build_type>` as
appropriate for your project.
- [ ] Set required [GitHub Actions secrets]. You can also **contact person in
charge for this** to do it for you.
- [ ] Create a new project on the CodeChecker server. You can also **contact
person in charge** to do it for you.

### GitHub Actions

- [ ] Set required [GitHub Actions secrets].
- [ ] Create a new project on the [CodeChecker server].
- [ ] Ensure that all rule targets provided in the example makefile work and are
relevant for your project. Change them or remove them, if you need to. If
you remove them make sure that they are not called from the enabled
workflows.
- [ ] (Optional) Include the `twister-rpi.yaml` GitHub Actions workflow for the
on-target testing. To do this copy the workflow from the [Twister RPi
workflow] into this project and see it's [README.md] in this repo for more
information on the requirements and setup.

### Cleanup

- [ ] Remove any files and folders that your project doesn't require. This avoid
possible multiple definition issues down the road and keeps your project
clean from redundant files.
- [ ] Ensure that all rule targets provided in the example makefile work and are
relevant for your project. Change them or remove them, if you need to. If
you remove them make sure that they are not called from the enabled
workflows.
- [ ] As a final step delete this checklist and commit changes.

[repository naming scheme]:
Expand All @@ -43,6 +55,8 @@ of CI workflows for release automation.
[README.md]: scripts/rpi-jlink-server/README.md
[Twister RPi workflow]:
https://github.com/IRNAS/irnas-workflows-software/tree/main/workflow-templates/rpi-twister-hil
[CodeChecker server]:
https://github.com/IRNAS/irnas-codechecker-software?tab=readme-ov-file#creating-new-products---codechecker-integration-in-east

## Setup

Expand All @@ -66,6 +80,12 @@ east install toolchain
east update
```

### Setup `pre-commit`

Turn on `pre-commit` tool by running `pre-commit install`. If you do not have it
yet, follow instructions
[here](https://github.com/IRNAS/irnas-guidelines-docs/tree/main/tools/pre-commit).

## Building and flashing

To build the application firmware:
Expand Down

0 comments on commit bc5bc91

Please sign in to comment.