Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates contributing.md #166

Merged
merged 3 commits into from
Sep 19, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,32 @@ ideas came.
* **Do** follow the [50/72 rule]
(http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
for Git Commit messages
* **Do** create a [topic branch]
(http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches)
to work on instead of working directly on `master`.
* **Do** fork the main repo via github, click the fork button
* **Do** clone your forked repo to your local system using the
`git clone` command followed by something like
git@github.com:username/Kansa.git
* **Do** track the remote upstream branch, from your local repo
do this:
`git remote add upstream git@github.com:davehull/Kansa.git`
then do this: `git remote -v` and make sure you have origin
tracking your fork and upstream tracking against the original
repo.
* **Do** create a [topic branch] from within your local clone of
your fork from the command line interface in your local system,
this may look like the following sequence of commands:
`git branch` are you on master? That's a good starting point.
If you're on master, you can make sure your master is up to date by
doing: `git pull upstream master --rebase`. In general, you want to
make any changes to your local repo using feature branches. So after
getting your local master up to date, create a new feature branch by
doing: `git checkout -b <featurename>`, which will create a new
branch. Once you're in that branch, you can start coding up your
feature or change. Once you are done, do the normal `git add`, and
`git commit` process, then when you go to `git push`, git will tell
you what to do, follow the prompt. Once you've pushed to your origin,
open your web browser and use the git web interface to open a PR
against master. There's no dev branch, that's for suckers. Kansa's
admins will merge your changes from master down to a release branch.

### Pull Requests

Expand All @@ -34,8 +57,7 @@ aliases.
You aren't expected to fix other people's bugs, but you can if you want.

#### New Modules
* **Do** try to make your module return Powershell objects.
* **Do** specify an # OUTPUT directive on line one of your module.
* **Do** make your module return Powershell objects.
* **Do** allow your modules to return error messages, unless you've
written code to handle them specifically. In general, if something
goes wrong, user's want to know about it.
Expand Down