Get In Touch: Difference between revisions

Line 11:

== Create pull requests ==

If you want to see your package being provided by a channel, creating an issue will most likely not enough. It is up to you to create a [[Contributing to Nixpkgs|nix package description]] in Nixpkgs and create a [[pull request]] in the Nixpkgs repository.

If you want to see your package being provided by a channel, creating an issue will most likely not enough. It is up to you to create a [[Contributing to Nixpkgs|nix package description]] in Nixpkgs and create a pull request in the Nixpkgs repository. Pull requests are a way to tell a github project that you've created some changes, which maintainers can easily review, comment on and, and finally merge into the repository.

Here's how to create a pull request on GitHub:

# Create a github account and fork nixpks/nixos/... repository.

# On you host, create a new remote location:

# add your github clone as remote location:

YOUR_GITHUB_NAME=fill-in

git remote add $YOUR_GITHUB_NAME git@github.com:$YOUR_GITHUB_NAME/nixpkgs.git

</syntaxhighlight>

# git commit your change

git add FILE_LIST # eventually use git add --patch

git commit

# verify everything is ok - no unexpected dangling files git does not know about yet:

git status

</syntaxhighlight>

# submitting your change, push to your repository:

# recommended: create a topic branch, so that this change

# can be submitted independently from other patches:

git checkout -tb submit/your-topic-name

git push $YOUR_GITHUB_NAME submit/your-topic-name

</syntaxhighlight>

goto gituhb.com/your_name -> create pull request

Why create your own branch? You can follow upstream (master) by running "git merge master".

You can "git commit --amend" fixes and "git push -f" your branch.

You can always switch back to master by "git checkout master".

For long living topic branches you may want to read [[Nixpkgs_and_TopGit]] which allows to squash many changes so that patches will always be easy to review.

== Becoming a Nixpkgs maintainer ==

@@ Line 11: / Line 11: @@
 == Create pull requests ==
-If you want to see your package being provided by a channel, creating an issue will most likely not enough. It is up to you to create a [[Contributing to Nixpkgs|nix package description]] in Nixpkgs and create a [[pull request]] in the Nixpkgs repository.
+If you want to see your package being provided by a channel, creating an issue will most likely not enough. It is up to you to create a [[Contributing to Nixpkgs|nix package description]] in Nixpkgs and create a pull request in the Nixpkgs repository. Pull requests are a way to tell a github project that you've created some changes, which maintainers can easily review, comment on and, and finally merge into the repository.
+Here's how to create a pull request on GitHub:
+# Create a github account and fork nixpks/nixos/... repository.
+# On you host, create a new remote location:
+<syntaxhighlight lang="bash">
+# add your github clone as remote location:
+YOUR_GITHUB_NAME=fill-in
+git remote add $YOUR_GITHUB_NAME git@github.com:$YOUR_GITHUB_NAME/nixpkgs.git
+</syntaxhighlight>
+#  git commit your change
+<syntaxhighlight lang="bash">
+git add FILE_LIST # eventually use git add --patch
+git commit
+# verify everything is ok - no unexpected dangling files git does not know about yet:
+git status
+</syntaxhighlight>
+# submitting your change, push to your repository:
+<syntaxhighlight lang="bash">
+# recommended: create a topic branch, so that this change
+# can be submitted independently from other patches:
+git checkout -tb submit/your-topic-name
+git push $YOUR_GITHUB_NAME submit/your-topic-name
+</syntaxhighlight>
+goto gituhb.com/your_name -> create pull request
+Why create your own branch? You can follow upstream (master) by running "git merge master".
+You can "git commit --amend" fixes and "git push -f" your branch.
+You can always switch back to master by "git checkout master".
+For long living topic branches you may want to read [[Nixpkgs_and_TopGit]] which allows to squash many changes so that patches will always be easy to review.
 == Becoming a Nixpkgs maintainer ==