Merge pull request #3 from teloscube/vst/get-ready-for-release

Getting Ready for Release

.Rbuildignore

@@ -1,3 +1,4 @@
+.chglog
 .lintr
 ^.*\.Rproj$
 ^\.Rproj\.user$

.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,56 @@
+{{ if .Versions -}}
+<a name="unreleased"></a>
+## [Unreleased]
+
+{{ if .Unreleased.CommitGroups -}}
+{{ range .Unreleased.CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+{{ range .RevertCommits -}}
+- {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Pull Requests
+{{ range .MergeCommits -}}
+- {{ .Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

.chglog/config.yml

@@ -0,0 +1,28 @@
+style: github
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/teloscube/rdecaf
+options:
+  commits:
+    # filters:
+    #   Type:
+    #     - feat
+    #     - fix
+    #     - perf
+    #     - refactor
+  commit_groups:
+    # title_maps:
+    #   feat: Features
+    #   fix: Bug Fixes
+    #   perf: Performance Improvements
+    #   refactor: Code Refactoring
+  header:
+    pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
+    pattern_maps:
+      - Type
+      - Scope
+      - Subject
+  notes:
+    keywords:
+      - BREAKING CHANGE

NEWS.md

@@ -0,0 +1,41 @@
+<a name="unreleased"></a>
+## [Unreleased]
+
+### Chore
+- prefix all source files with depr_
+- update LICENSE
+- review DecafClient implementation
+- update DESCRIPTION
+- **build:** attend check notice
+- **build:** bump roxygen2 version
+- **dev:** configure linter
+- **dev:** add Nix shell
+- **dev:** add lintr configuration
+- **docs:** revisit the documentation of DecafClient class
+- **docs:** regenerate R documentation files
+- **docs:** start tutorial document
+
+### Feat
+- add bare DECAF HTTP client
+
+
+<a name="0.0.5"></a>
+## [0.0.5] - 2019-05-08
+
+<a name="0.0.4"></a>
+## [0.0.4] - 2018-03-13
+
+<a name="0.0.3"></a>
+## [0.0.3] - 2018-03-06
+
+<a name="0.0.2"></a>
+## [0.0.2] - 2017-07-10
+
+<a name="0.0.1"></a>
+## 0.0.1 - 2017-03-19
+
+[Unreleased]: https://github.com/teloscube/rdecaf/compare/0.0.5...HEAD
+[0.0.5]: https://github.com/teloscube/rdecaf/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/teloscube/rdecaf/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/teloscube/rdecaf/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/teloscube/rdecaf/compare/0.0.1...0.0.2

README.md

@@ -1,3 +1,63 @@
-# rdecaf: An API Client Library for DECAF suite
+# rdecaf: DECAF API Client for R Language
 
-> TODO: Provide a more detailed README.
+*rdecaf* is an R library that provides client functionality to DECAF API suite.
+
+DECAF is a proprietary Financial Portfolio Management, Analytics, Reporting and
+Productivity Suite offered as a Software as a Service (SaaS) solution. It
+provides an API suite over HTTP exposing its functionality and data it hosts.
+*rdecaf* is used internally to enhance DECAF's own functionality, and by
+third-parties to integrate into third-party systems.
+
+## Installation
+
+*rdecaf* is currently NOT on CRAN. A typical way to install *rdecaf* is via
+[devtools](https://devtools.r-lib.org/). For latest released version:
+
+```sh
+devtools::install_github("teloscube/rdecaf", ref = "main", upgrade = "ask")
+```
+
+... and for the development version:
+
+```sh
+devtools::install_github("teloscube/rdecaf", ref = "develop", upgrade = "ask")
+```
+
+## Development
+
+Development is carried on under a [Nix](https://nixos.org/explore.html) Shell.
+If you are on Nix, you can enter the Nix Shell provided with:
+
+```sh
+nix-shell
+```
+
+A few things to note:
+
+1. Make sure that the package is in good shape:
+
+    ```sh
+    devtools::check(".")
+    ```
+
+2. We are using [Semantic Versioning](https://semver.org/). However, we have NOT
+   released a major version YET. Therefore, expect breaking changes between
+   releases.
+3. We are using [Conventional
+   Commits](https://www.conventionalcommits.org/en/v1.0.0/) since the
+   development version `0.0.5.9000`. Make sure that your commit messages are
+   compliant to these conventions. This will ensure a nice, automated changelog
+   ([./NEWS.md](./NEWS.md)) generation.
+4. Development is carried under the `develop` branch. Pull Requests (PRs) are
+   preferred over direct commits to `develop` branch.
+5. `main` branch is for the latest released version. No development shall be
+   done against the `main` branch.
+6. We do not have strong preference over core formatting YET. We are currently
+   using the `lintr` tool for this purposes. This can change or `.lintr`
+   configuration may change over time.
+
+## LICENSE
+
+This work is released under MIT license.
+
+See [./LICENSE](./LICENSE).

shell.nix

@@ -23,5 +23,7 @@ in
 mkShell {
   buildInputs = [
     thisR
+
+    pkgs.git-chglog
   ];
 }