Skip to content

Commit

Permalink
chore: fix splash typo, minor changes to the PR template and commit m…
Browse files Browse the repository at this point in the history
…sg ref, added convenient run config
  • Loading branch information
RedLeader962 committed Dec 22, 2023
1 parent da03e7a commit a94cb28
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 34 deletions.
69 changes: 38 additions & 31 deletions .github/pull_request_template.md
@@ -1,47 +1,54 @@
# Description
### Summary:




### Summary:

### Changes and type of changes (quick overview):

### Changes and type of changes:

-
-
-

-
-
-

---

# Checklist:

### Code related
- [ ] I have made corresponding changes to the documentation (i.e.: function, class, script header,
README.md)
- [ ] I have commented hard-to-understand code

- [ ] I have made corresponding changes to the documentation
(i.e.: function, class, script header, README.md)
- [ ] I have commented hard-to-understand code
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] All tests pass locally with my changes (Check [README.md #Contributing](https://github.com/norlab-ulaval/libpointmatcher/tree/release#contributing) for local testing procedure using _libpointmatcher-build-system_)
- [ ] All tests pass locally with my changes
(Check [README.md #Contributing](https://github.com/norlab-ulaval/libpointmatcher/tree/develop#contributing)
for local testing procedure using _libpointmatcher-build-system_)

### PR creation related

### PR creation related
- [ ] My pull request `base ref` branch is set to the `develop` branch (the _build-system_ won't be triggered otherwise)
- [ ] My pull request branch is up-to-date with the `develop` branch (the _build-system_ will reject it otherwise)
- [ ] My pull request `base ref` branch is set to the `develop` branch
(the _build-system_ won't be triggered otherwise)
- [ ] My pull request branch is up-to-date with the `develop` branch
(the _build-system_ will reject it otherwise)

### PR description related

### PR description related
- [ ] I have included a quick summary of the changes
- [ ] I have included a high-level list of changes and their corresponding type
- Types: `feat` `fix` `docs` `style` `refactor` `perf` `test` `build` `ci` `chore` `revert`
- Breaking changes: `<type>!`
- Reference:
- See [commit_msg_reference.md](https://github.com/norlab-ulaval/libpointmatcher/blob/release/commit_msg_reference.md) in the repository root for details
- https://www.conventionalcommits.org
- [ ] I have indicated the related issue's id with `# <issue-id>` if changes are of type `fix`
- [ ] I have included a high-level list of changes and their corresponding type
- Types: `feat` `fix` `docs` `style` `refactor` `perf` `test` `build` `ci` `chore` `revert`
- Breaking changes: `<type>!`
- Reference:
see [commit_msg_reference.md](https://github.com/norlab-ulaval/libpointmatcher/blob/develop/commit_msg_reference.md)
in the repository root for details

---

## Note for repository admins

### Release PR related

## Note for repository admins
### Release PR related
- Only repository admins have the privilege to `push/merge` on the default branch (ie: `master`) and the `release` branch.
- Keep PR in `draft` mode until all the release reviewers are ready to push the release.
- Once a PR from `release` -> `master` branch is created (not in draft mode),
- it triggers the _build-system_ test
- (in-progress) and it triggers the _semantic release automation_
- Only repository admins have the privilege to `push/merge` on the default branch (ie: `master`)
and the `release` branch.
- Keep PR in `draft` mode until all the release reviewers are ready to push the release.
- Once a PR from `release` -> `master` branch is created (not in draft mode),
- it triggers the _build-system_ test
- (in-progress) and it triggers the _semantic release automation_
4 changes: 2 additions & 2 deletions build_system/.env
Expand Up @@ -29,8 +29,8 @@ NBS_SUPERPROJECT_BUILD_SYSTEM_DIR=./build_system
# NorLab-build-system & NorLab-sheel-script-tools
#
PROJECT_PROMPT_NAME=LPM
NBS_SPLASH_NAME="Libpoinmatcher"
NBS_SPLASH_NAME_BUILD_SYSTEM="Libpoinmatcher Build System"
NBS_SPLASH_NAME="Libpointmatcher"
NBS_SPLASH_NAME_BUILD_SYSTEM="Libpointmatcher Build System"

#
# Docker built-in environment variable (do not change the variable name
Expand Down
@@ -0,0 +1,19 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="[LPM] run all bats tests" type="ShConfigurationType" folderName="[LPM] A | bats tests">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/build_system/tests/run_bats_core_test_in_n2st.bash" />
<option name="SCRIPT_OPTIONS" value="build_system/tests/tests_bats/" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$/build_system" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/zsh" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="false" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs>
<env name="DOCKER_CONTEXT" value="desktop-linux" />
</envs>
<method v="2" />
</configuration>
</component>
2 changes: 1 addition & 1 deletion commit_msg_reference.md
@@ -1,4 +1,4 @@
# Conventional Commits
# _Conventional Commits_ specification quick reference

See https://www.conventionalcommits.org for details

Expand Down

0 comments on commit a94cb28

Please sign in to comment.