Contribution guide and changelog #65
Conversation
CONTRIBUTING.md
Outdated
| * **assignments**: only with `=`, | ||
| * **quoting** (e.g., of strings): always use double quotes instead of single quotes, | ||
| * **Booleans**: always write `TRUE` instead of `T` (analogously for `FALSE` and `F`), and | ||
| * **square-brackets notation**: always access values in lists or data.frame using the square-brackets notation (e.g., `df["column1"]` or `list1[["1"item1"]]` |
There was a problem hiding this comment.
There is something wrong in the example list1[["1"item1"]]. I guess the second 1 (of three) can be removed
|
Neither the Google Style Guide nor this one seem to mention the usage of implicit or explicit return statements. Is there any preference on that topic? See also: |
Most style guides recommend to use the I will add a proper item to the contribution guide, thanks for pointing this out, @flx5. |
|
Before merging this pull request, we should check that all present implementations satisfy the coding conventions. Especially, check for |
|
We should add a comment on the date-parsing functions after PR #85 is merged. |
By introducing the function 'verify.argument.for.parameter', we can properly check all arguments for our classes' constructors, just in case. This fixes #79. Signed-off-by: Claus Hunsen <[email protected]>
This fixes #99. Signed-off-by: Claus Hunsen <[email protected]> Signed-off-by: Thomas Bock <[email protected]>
For a better documentation on how to contribute to the project, we add a contribution guide along with an issue template. This is considered a first draft working on #47. Signed-off-by: Claus Hunsen <[email protected]>
The file 'NEWS.md' now holds the changelog of the network library for better overview. The main sections are "added", "changed/improved", and "fixes". Added: Indicating completely new functionality, such as added features or functions (e.g., adding the splitting functionality). Changed/improved: Indicating adapted or updated functionality (e.g., updating the plotting functionality with the help of another R package). Fixed: Indicating real fixes for bugs and regressions (e.g., fixing a typo in a function call). Later, the upcoming sections for new versions should be added, on the one side, automatically generated from the commit list and, on the other side, with a self-written text, pointing out the overall synopsis and the highlights. Signed-off-by: Claus Hunsen <[email protected]>
Signed-off-by: Claus Hunsen <[email protected]>
Add a more precise explanation to improve understanding on how to structure changes in commits. Signed-off-by: Claus Hunsen <[email protected]>
Add a rule on square-brackets notation for accessing data in data.frames or lists. Add a rule to keep the code as simple as possible. Improve typographical stuff.
Props to @bockthom for pointing this out. Signed-off-by: Claus Hunsen <[email protected]>
Props to @flx5 for pointing this out. Signed-off-by: Claus Hunsen <[email protected]>
Signed-off-by: Claus Hunsen <[email protected]>
As a result of issue #77 and the respective PRs, we can now instruct developers to use the appropriate functions for date handling. Signed-off-by: Claus Hunsen <[email protected]>
Signed-off-by: Claus Hunsen <[email protected]>
Update project description. Add 'issues.only.comments' in the `ProjectConf` section. Add 'util-networks-covariates.R' to module overview. Add remark on 'dev' branch. Signed-off-by: Claus Hunsen <[email protected]>
|
I will close this for now and include the patches in a new PR which combines all open patches for |
With this PR, I aim at integrating a contribution guide for the network library (see #47). It is basically about how to open issues or pull request and how to write patches in terms of coding conventions.
Additionally, I started a NEWS file which is basically a changelog - to keep better track of changes and enhancements during/before updating.
Important note: All documents proposed here are intended to be used by both developers and users of the network library!
I do not intend to merge the documents right away, I rather intend to discuss and improve the documents here as I definitely missed something. If you have any suggestions or improvements to the proposed documents, comment here or even write a patch that I can integrate.
Note: I will do a rebase to make this branch up-to-date with
devright before merging.