ngiger
March 27, 2020, 9:12pm
1
As it took me too long to create my backup job running using borgbackup, I decided to try to improve the documentation.
In the README.md I followed the link to the contributing page
# How to contribute
Note: contributing implies licensing those contributions
under the terms of [COPYING](../COPYING), which is an MIT-like license.
## Opening issues
* Make sure you have a [GitHub account](https://github.com/signup/free)
* Make sure there is no open issue on the topic
* [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and fill out the template
## Submitting changes
* Format the commit messages in the following way:
```
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
(Motivation for change. Additional information.)
```
show original
Then I opened the bug report borgbackup: Improve documentation · Issue #83525 · NixOS/nixpkgs · GitHub
As my patch was ready I submitted the pull request
NixOS:master ← ngiger:83525
opened 08:57PM - 27 Mar 20 UTC
Added an example on howto create a backup job to
a remote borg server.
Teste… d with my borgbase.com account.
###### Motivation for this change
###### Things done
- [ ] Tested using sandboxing ([nix.useSandbox](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](http://nixos.org/nix/manual/#sec-conf-file) on non-NixOS linux)
- Built on platform(s)
- [ ] NixOS
- [ ] macOS
- [ ] other Linux distributions
- [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests))
- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"`
- [ ] Tested execution of all binary files (usually in `./result/bin/`)
- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
- [ ] Ensured that relevant documentation is up to date
- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
But I failed to follow the suggestion from then manual in chapter “19.2. Submitting changes” where they suggest
What is meant by “the message”?
the message here refers either to PR description or a comment. Either action will create a github notification for the individual (and an email, if they have that enabled)