Skip to content
Permalink
Browse files

doc: improvements

  • Loading branch information...
markus2330 committed Jun 1, 2019
1 parent 765573b commit 0125118231d53c5be8f8f843c5c5b63a87a27bbf
Showing with 16 additions and 12 deletions.
  1. +12 −8 .github/PULL_REQUEST_TEMPLATE.md
  2. +1 −1 doc/CODING.md
  3. +2 −2 doc/DESIGN.md
  4. +1 −1 doc/news/_preparation_next_release.md
@@ -20,17 +20,21 @@ need to be checked.
- [ ] I added unit tests
- [ ] I ran all tests locally and everything went fine
- [ ] affected documentation is fixed
- [ ] I added code comments, logging, and assertions (see doc/CODING.md)
- [ ] meta data is updated (e.g. README.md of plugins and doc/METADATA.md)
- [ ] I added code comments, logging, and assertions (see [Coding Guidelines](/doc/CODING.md))
- [ ] meta data is updated (e.g. README.md of plugins and [METADATA.ini](/doc/METADATA.md))

## Review

Remove the line below and add the "work in progress" label if you do
not want the PR to be reviewed:
Reviewers will usually check the following:

@markus2330 please review my pull request
- [ ] Code is conforming to [our Coding Guidelines](/doc/CODING.md)
- [ ] APIs are conforming to [our Design Guidelines](/doc/DESGIN.md)
- [ ] Code is consistent to [our Design Decisions](/doc/decisions)
- [ ] Documentation is concise and good to read
- [ ] Examples are well chosen and understandable

## Merging
## Labels

Please add the "ready to merge" label when the build server and you say
that everything is ready to be merged.
- Add the "work in progress" label if you do not want the PR to be reviewed yet.
- Add the "ready to merge" label **if the build server is happy** and also you
say that everything is ready to be merged.
@@ -128,7 +128,7 @@ So do not give this responsibility out of hands entirely.
- Use `const` as much as possible.
- Use `static` methods if they should not be externally visible.
- C-Files have extension `.c`, Header files `.h`.
- Use internal functions: prefer to use elektraMalloc, elektraFree.
- Use internal functions: prefer to use `elektraMalloc`, `elektraFree`.

**Example:** [src/libs/elektra/kdb.c](/src/libs/elektra/kdb.c)

@@ -32,8 +32,8 @@ in the next section.
Elektra manages memory itself. This means, a programmer is not allowed
to use free on data, which was not allocated by himself. This avoids
situation where the programmer forgets to free data, and makes the API
more beginner-friendly. In addition to that, `elektraMalloc` and free
must use the same libc version. `elektraMalloc` in a library linked
more beginner-friendly. In addition to that, `elektraMalloc` and `free`
must use the same libc version: `elektraMalloc` in a library linked
against another libc, but freed by the application could lead to hard
to find bugs.

@@ -657,7 +657,7 @@ mounted, use `kdb gen -F <plugin>:<file> elektra <parentKey> <outputName>` to lo

- We increased the automatic timeout for jobs that show no activity from 5 to 10 minutes. _(René Schwaiger)_
- We improved the exclusion patterns for the [Coveralls coverage analysis](https://coveralls.io/github/ElektraInitiative/libelektra). _(René Schwaiger)_
- We now again build the API docu of master. _(Markus Raab)_
- We now again build the API docu of [master](https://doc.libelektra.org/api/master) and we now also build the API docu of [PRs](https://doc.libelektra.org/api/pr/). _(Markus Raab)
### Travis

0 comments on commit 0125118

Please sign in to comment.
You can’t perform that action at this time.