summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorArseniy Seroka <ars.seroka@gmail.com>2015-06-21 18:32:54 +0300
committerArseniy Seroka <ars.seroka@gmail.com>2015-06-21 18:32:54 +0300
commit0ba0ae752ceaac8fe97f91e3253fba0b0098c369 (patch)
treedf1a94d89e09e3241b4cd1d1342730573d3cd996 /CONTRIBUTING.md
parentcf44a27fc45514737e54d27c9b513a1a4d6885ff (diff)
CONTRIBUTING.md: fix typos
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md36
1 files changed, 18 insertions, 18 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3cc4f5619d96..764508ca25f0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,13 +3,13 @@
## Opening issues
* Make sure you have a [GitHub account](https://github.com/signup/free)
-* [Submit an issue](https://github.com/NixOS/nixpkgs/issues) - assuming one does not already exist
- * Clearly describe the issue including steps to reproduce when it is a bug
- * Include information what version of nixpkgs and Nix are you using (nixos-version or git revision)
+* [Submit an issue](https://github.com/NixOS/nixpkgs/issues) - assuming one does not already exist.
+ * Clearly describe the issue including steps to reproduce when it is a bug.
+ * Include information what version of nixpkgs and Nix are you using (nixos-version or git revision).
## Making patches
-* Read [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/)
+* Read [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/).
* Fork the repository on GitHub.
* Create a branch for your future fix.
* You can make branch from a commit of your local `nixos-version`. That will help you to avoid additional local compilations. Because you will recieve packages from binary cache.
@@ -35,8 +35,8 @@
* `firefox: 3.0 -> 3.1.1`
* `hydra service: add bazBaz option`
* `nginx service: refactor config generation`
-* Test your changes. If you work with
- * nixpkgs
+* Test your changes. If you work with
+ * nixpkgs:
* update pkg ->
* `nix-env -i pkg-name -f <path to your local nixpkgs folder>`
* add pkg ->
@@ -45,25 +45,25 @@
* _If you don't want to install pkg in you profile_.
* `nix-build -A pkg-attribute-name <path to your local nixpkgs folder>/default.nix` and check results in the folder `result`. It will appear in the same directory where you did `nix-build`.
* If you did `nix-env -i pkg-name` you can do `nix-env -e pkg-name` to uninstall it from your system.
- * NixOS and its modules
- * You can add new module to your NixOS configuration file (usually it's `/etc/nixos/configuration.nix`.
- And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`
+ * NixOS and its modules:
+ * You can add new module to your NixOS configuration file (usually it's `/etc/nixos/configuration.nix`).
+ And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`.
* If you have commits `pkg-name: oh, forgot to insert whitespace`: squash commits in this case. Use `git rebase -i`.
* Rebase you branch against current `master`.
## Submitting changes
* Push your changes to your fork of nixpkgs.
-* Create pull request.
- * Write the title in format `(pkg-name | service): improvement`
- * If you update the pkg, write versions `from -> to`
+* Create pull request:
+ * Write the title in format `(pkg-name | service): improvement`.
+ * If you update the pkg, write versions `from -> to`.
* Write in comment if you have tested your patch. Do not rely much on `TravisCI`.
- * If you make an improvement, write about your motivation
- * Notify maintainers of the package. For example add to the message: `cc @jagajaga @domenkozar`
+ * If you make an improvement, write about your motivation.
+ * Notify maintainers of the package. For example add to the message: `cc @jagajaga @domenkozar`.
## Hotfixing pull requests
-* Make the appropriate changes in you branch
-* Don't create additional commits
- * `git rebase`
- * `git push --force` to your branch
+* Make the appropriate changes in you branch.
+* Don't create additional commits, do
+ * `git rebase -i`
+ * `git push --force` to your branch.