summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2015-06-21 14:37:54 +0200
committerDomen Kožar <domen@dev.si>2015-06-21 14:38:20 +0200
commit75f4709fe3835d56cee1860696fa421d96165b6e (patch)
treed0a09402c067e6ac296b96ca1d7a18c5d0a7d5c9 /CONTRIBUTING.md
parent7ed48bff724d01e38e5e77a9c48d122f4386b892 (diff)
downloadnixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar.gz
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar.bz2
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar.lz
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar.xz
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.tar.zst
nixpkgs-75f4709fe3835d56cee1860696fa421d96165b6e.zip
CONTRIBUTING.md: mostly style fixes
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 76343b0434f..af89187af29 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,15 +3,16 @@
 ## Opening issues
 
 * Make sure you have a [GitHub account](https://github.com/signup/free)
-* Submit a ticket for your issue, assuming one does not already exist.
-  * Clearly describe the issue including steps to reproduce when it is a bug.
+* [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/)
 * 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 some packages from cache server.
+  * 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.
     * For example: `nixos-version` returns `15.05.git.0998212 (Dingo)`. So you can do:
 
         ```bash
@@ -20,22 +21,22 @@
         ```
   * Please avoid working directly on the `master` branch.
 * Make commits of logical units. 
-  * If you removed pkgs, made some major changes etc., write about them in `nixos/doc/manual/release-notes/rl-unstable.xml`.
+  * If you removed pkgs, made some major NixOS changes etc., write about them in `nixos/doc/manual/release-notes/rl-unstable.xml`.
 * Check for unnecessary whitespace with `git diff --check` before committing.
 * Format the commit in a following way:
 
         ```
-        (pkg-name | service-name): (update from -> to | init at version | refactor | etc)
+        (pkg-name | service-name): (from -> to | init at version | refactor | etc)
 
         Additional information.
         ```
   * Examples:
     * `nginx: init at 2.0.1`
-    * `firefox: update 3.0 -> 3.1.1`
+    * `firefox: 3.0 -> 3.1.1`
     * `hydra service: add bazBaz option`
     * `nginx service: refactor config generation`
 * Test your changes. If you work with 
-  * nixpkgs
+  a) nixpkgs
     * update pkg -> 
       * `nix-env -i pkg-name -f <path to your local nixpkgs folder>`
     * add pkg -> 
@@ -44,8 +45,8 @@
     * _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 you `nixos-configuration file` (usually it's `/etc/nixos/configuration.nix`.  
+  b) 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`.
@@ -57,12 +58,12 @@
   * 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 why is it good.
+  * 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.
+* Make the appropriate changes in you branch
+* Don't create additional commits
   * `git rebase`
-  * `git push --force` to your branch.
+  * `git push --force` to your branch