Skip to content

Commit

Permalink
Added submission checklist to contributing docs.
Browse files Browse the repository at this point in the history
Added backtrace/segfault handling to Changelog and ReleaseNotes.
Pull latest CException.
  • Loading branch information
mvandervoord committed Apr 13, 2024
1 parent 24ccb3d commit 24a0af4
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 1 deletion.
12 changes: 12 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,18 @@ Resolves: #123
See also: #456, #789
```

## :white_check_mark: Pull Request Checklist

Not all Pull Requests require these things, but here's a great list of things to check to see if it makes sense for your situation:

- [ ] Are the changes complete?
- [ ] Are there tests for the new functionality?
- [ ] Are the changes passing the style checks?
- [ ] Is there documentation for the new functionality?
- [ ] Has the change been added to `Changelog.md`?
- [ ] Has the change been added to `ReleaseNotes.md`?
- [ ] Have new config options been added as defaults to the `project.yml` files?

## :heart: Who Loves Emoji?

Commit comments, Issues, Feature Requests... they can all use a little sprucing up, right? Consider using the following emoji for a mix of function and :sparkles: dazzle!
Expand Down
4 changes: 4 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ This new plugin also includes the option to generate an HTML report (see next se

A community member submitted an [HTML report generation plugin](https://github.com/ThrowTheSwitch/Ceedling/pull/756/) that was not officially released before 0.32. It has been absorbed into the new `report_tests_log_factory` plugin (see previous section).

### Improved Segfault Handling

Segmentation faults are now reported as failures instead of an error and given as fine of detail as possible for the current feature set. See the docs on `:backtrace` for more!

## 💪 Fixed

### `:paths` and `:files` handling bug fixes and clarification
Expand Down
4 changes: 4 additions & 0 deletions docs/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ The previously undocumented build directive macro `TEST_FILE(...)` has been rena

Ceedling has been around for a number of years and has had the benefit of many contributors over that time. Preprocessing (expanding macros in test files and header files to be mocked) is quite tricky to get right but is essential for big, complicated test suites. Over Ceedling’s long life various patches and incremental improvements have evolved in such a way that preprocessing had become quite complicated and often did the wrong thing. Much of this has been fixed and improved in this release.

#### Segfault Handling

Previously, if a test executable ran into a segmentation fault (usually caused by memory issues in the code), the entire test executable would report nothing and an error would be reported. This behavior has been improved so that segfaults result in rerunning each test individually to narrow down which test caused the problem. Each segfault is reported with its own failure. Also, the `:use_backtrace` option can be enabled if `gdb` is properly installed and configured, so that the specific line that caused the segfault can be reported.

#### Documentation

The Ceedling user guide, _[CeedlingPacket](CeedlingPacket.md)_, has been significantly revised and expanded. We will expand it further in future releases and eventually break it up into multiple documents or migrate it to a full documentation management system.
Expand Down
2 changes: 1 addition & 1 deletion vendor/c_exception
Submodule c_exception updated 1 files
+217 −4 project.yml

0 comments on commit 24a0af4

Please sign in to comment.