Skip to content
Snippets Groups Projects
Commit 9367a861 authored by wbonat's avatar wbonat
Browse files

Merge branch 'devel' into issue#5

parents 19191fb6 f0b4af83
No related branches found
No related tags found
No related merge requests found
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
^\.Rproj\.user$ ^\.Rproj\.user$
^.Rd2pdf* ^.Rd2pdf*
^\.Rd2pdf* ^\.Rd2pdf*
^\.gitlab-ci.yml$
.Rd2pdf5504 .Rd2pdf5504
.Rd2pdf5516 .Rd2pdf5516
.Rd2pdf* .Rd2pdf*
...@@ -11,3 +12,5 @@ Examples/ ...@@ -11,3 +12,5 @@ Examples/
^data-raw$ ^data-raw$
\#*\# \#*\#
^\.\#* ^\.\#*
Rplots.pdf
CONTRIBUTING.md
\ No newline at end of file
...@@ -15,3 +15,4 @@ ...@@ -15,3 +15,4 @@
.Rd2pdf* .Rd2pdf*
data-raw/*.txt data-raw/*.txt
inst/doc inst/doc
Rplots.pdf
job_R:
script:
- echo $HOME
- Rscript -e 'getwd(); .libPaths(); sessionInfo()'
- Rscript -e 'library(devtools); check()'
- Rscript -e 'library(devtools); .libPaths(new = path.expand("~/R-tests/legTools")); install(local = FALSE)'
# Instructions for contributing
This guide contains instructions for collaborators to contribute with
the `mcglm` package.
The general guidelines for contributing to any of the projects in this
GitLab can be found in [Boas práticas do uso do Git e GitLab no LEG][]
(in portuguese only).
## Workflow
In `mcglm` we use the Gitflow workflow, which can be viewed in these
two links: [A successful Git branching model][], and
[Atlassian tutorial][].
Basically, all the ongoing development is made in the `devel`
branch. New features and bug fixes must are made in additional (parallell)
branches such like `issue#<num>`, where `<num>` is an incremental
number. Each new feature or bug fix must have a corresponding issue,
created in the GitLab interface. In this issue you must describe in
details what are the things to do (or fix). The number of the issue is
created automatically by GitLab, and this number must correspond to the
`<num>` in the branch name. After someone (yourself or others) have
finished working in the issue, in branch `issue#<num>`, he must send a
Merge Request (MR), preferably to @wbonat, to merge this branch to
`devel`.
Basically, the workflow follows this steps:
1. All the ongoing work is done in the `devel` branch
2. When it is decided that a new version is ready for release, it is
moved to the `master` branch, where it receives a tag with the version
number, and nothingmore is added in the `master` branch
To suggest or add new features or bug reports:
1. Open an issue in the GitLab interface
2. The person who will work on this issue must then create a new
branch (from `devel`) with the name `issue#<num>`, where `<num>` is
the number of the issue
3. When the work on this issue is finished, the person must create a
Merge Request (MR) to incorporate changes from `issue#<num>` to
`devel`
The `issue#<num>` branches are merged with the `devel` branch, where
final tests are made to guarantee it is stable. Only then it is moved to
the `master` branch. Note that we don't use a `release` branch as in a
traditional Gitflow workflow (this is the only difference).
This way, users may opt to install the stable version, from the `master`
branch, or they may install the development version from the `devel`
branch.
To contribute to the project, please review the commits in the `devel`
branch, and the list of issues (opened and closed) to make sure that
what you are trying to do is not already being done.
Also, if you're not sure about how to do something, but have an idea for
the project, feel free to open an issue and explain what you want from
there.
## General rules for commits
Commits are a very important part of git. The four most important rules
to follow are:
1. **Commit often**
2. **Don't commit half-done work**
3. **Test before you commit**
4. **Write good commit messages**
For more detailed explanation and specific guidelines, see
[Criando commits][] in [Boas práticas do uso do Git e GitLab no LEG][],
and [Version Control Best Practices][].
****
Fell free to contact us (via email or an issue) if you have any doubts
about contributing.
<!-- links -->
[A successful Git branching model]: http://nvie.com/posts/a-successful-git-branching-model/
[Atlassian tutorial]: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow
[Boas práticas do uso do Git e GitLab no LEG]: http://git.leg.ufpr.br/leg/gitlab-rautu/blob/master/CONTRIBUTING.md
[Version Control Best Practices]: http://www.git-tower.com/learn/git/ebook/command-line/appendix/best-practices
[Criando commits]: http://git.leg.ufpr.br/leg/gitlab-rautu/blob/master/CONTRIBUTING.md#criando-commits
...@@ -19,7 +19,7 @@ Suggests: ...@@ -19,7 +19,7 @@ Suggests:
latticeExtra latticeExtra
Imports: Imports:
Matrix, Matrix,
assertthat asserthat
License: GPL-2 License: GPL-2
LazyData: TRUE LazyData: TRUE
URL: http://git.leg.ufpr.br/wbonat/mcglm URL: http://git.leg.ufpr.br/wbonat/mcglm
......
LICENSE 0 → 100644
This diff is collapsed.
...@@ -10,11 +10,11 @@ pkg.win <- paste0(pkg.name, ver, ".zip") ...@@ -10,11 +10,11 @@ pkg.win <- paste0(pkg.name, ver, ".zip")
# mcglm `r ver` # mcglm `r ver`
<!-- [![build status](http://git.leg.ufpr.br/ci/projects/1/status.png?ref=master)](http://git.leg.ufpr.br/ci/projects/1?ref=master) --> [![build status](http://git.leg.ufpr.br/ci/projects/3/status.png?ref=master)](http://git.leg.ufpr.br/ci/projects/3?ref=master)
<!-- Build status for the stable version (`master` branch) --> Build status for the stable version (`master` branch)
<!-- -->
<!-- [![build status](http://git.leg.ufpr.br/ci/projects/1/status.png?ref=devel)](http://git.leg.ufpr.br/ci/projects/1?ref=devel) --> [![build status](http://git.leg.ufpr.br/ci/projects/3/status.png?ref=devel)](http://git.leg.ufpr.br/ci/projects/3?ref=devel)
<!-- Build status for the development version (`devel` branch) --> Build status for the development version (`devel` branch)
The `mcglm` package fit multivariate covariance generalized linear models The `mcglm` package fit multivariate covariance generalized linear models
(Bonat and Jorgensen, 2015). (Bonat and Jorgensen, 2015).
...@@ -116,9 +116,9 @@ See [LICENSE](./LICENSE) ...@@ -116,9 +116,9 @@ See [LICENSE](./LICENSE)
<!-- links --> <!-- links -->
```{r, echo=FALSE, include=FALSE} ```{r, echo=FALSE, include=FALSE}
pkg.source.link <- paste0("http://www.leg.ufpr.br/~fernandomayer/mcglm/", pkg.source.link <- paste0("http://www.leg.ufpr.br/~leg/mcglm/source/",
pkg.source) pkg.source)
pkg.win.link <- paste0("http://www.leg.ufpr.br/~fernandomayer/mcglm/", pkg.win.link <- paste0("http://www.leg.ufpr.br/~leg/mcglm/source/",
pkg.win) pkg.win)
``` ```
......
...@@ -2,11 +2,11 @@ ...@@ -2,11 +2,11 @@
# mcglm 0.0.1 # mcglm 0.0.1
<!-- [![build status](http://git.leg.ufpr.br/ci/projects/1/status.png?ref=master)](http://git.leg.ufpr.br/ci/projects/1?ref=master) --> [![build status](http://git.leg.ufpr.br/ci/projects/3/status.png?ref=master)](http://git.leg.ufpr.br/ci/projects/3?ref=master)
<!-- Build status for the stable version (`master` branch) --> Build status for the stable version (`master` branch)
<!-- -->
<!-- [![build status](http://git.leg.ufpr.br/ci/projects/1/status.png?ref=devel)](http://git.leg.ufpr.br/ci/projects/1?ref=devel) --> [![build status](http://git.leg.ufpr.br/ci/projects/3/status.png?ref=devel)](http://git.leg.ufpr.br/ci/projects/3?ref=devel)
<!-- Build status for the development version (`devel` branch) --> Build status for the development version (`devel` branch)
The `mcglm` package fit multivariate covariance generalized linear models The `mcglm` package fit multivariate covariance generalized linear models
(Bonat and Jorgensen, 2015). (Bonat and Jorgensen, 2015).
...@@ -113,7 +113,7 @@ See [LICENSE](./LICENSE) ...@@ -113,7 +113,7 @@ See [LICENSE](./LICENSE)
[GNU General Public License (GPL) v3.0]: http://www.gnu.org/licenses/gpl-3.0.html [GNU General Public License (GPL) v3.0]: http://www.gnu.org/licenses/gpl-3.0.html
[`roxygen2`]: https://github.com/klutometis/roxygen [`roxygen2`]: https://github.com/klutometis/roxygen
[`devtools`]: https://github.com/hadley/devtools [`devtools`]: https://github.com/hadley/devtools
[mcglm_0.0.1.tar.gz]: http://www.leg.ufpr.br/~fernandomayer/mcglm/mcglm_0.0.1.tar.gz [mcglm_0.0.1.tar.gz]: http://www.leg.ufpr.br/~leg/mcglm/source/mcglm_0.0.1.tar.gz
[mcglm_0.0.1.zip]: http://www.leg.ufpr.br/~fernandomayer/mcglm/mcglm_0.0.1.zip [mcglm_0.0.1.zip]: http://www.leg.ufpr.br/~leg/mcglm/source/mcglm_0.0.1.zip
[mcglm-manual.pdf]: http://www.leg.ufpr.br/~leg/mcglm/source/mcglm-manual.pdf [mcglm-manual.pdf]: http://www.leg.ufpr.br/~leg/mcglm/source/mcglm-manual.pdf
[Gitflow worflow]: http://nvie.com/posts/a-successful-git-branching-model/ [Gitflow worflow]: http://nvie.com/posts/a-successful-git-branching-model/
...@@ -14,7 +14,7 @@ if(!grepl(x=getwd(), pattern="/mcglm$")){ ...@@ -14,7 +14,7 @@ if(!grepl(x=getwd(), pattern="/mcglm$")){
library(devtools) library(devtools)
## Load the package (to make functiona available). ## Load the package (to make functions available).
load_all() load_all()
## Create/update NAMESPACE, *.Rd files. ## Create/update NAMESPACE, *.Rd files.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment