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.

Sign up for GitHub

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

Add Contributing guideline #555

Merged
merged 3 commits into from
Jul 31, 2016
Merged

Add Contributing guideline #555

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3de4817
Add contributing guideline
spacewander Jul 25, 2016
311ef28
modify CONTRIBUTING.md
spacewander Jul 29, 2016
d38d3f4
modify CONTRIBUTING.md again
spacewander Jul 30, 2016
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
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Your new git-extra command should support

* OSX, Ubuntu, FreeBsd(You may need to browse their man page)
Copy link
Collaborator

@qw3rtman qw3rtman Jul 29, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps OS X, Ubuntu, and FreeBSD (you may need to check the documentation for compatibility issues)*?

We could also add a note at the bottom (hence the *) saying something along the lines of "if you aren't able to test your new command on a platform, make that clear in your PR and someone else may be able to test it on their system"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of both of those suggestions.

* Bash 3.2+ (If you are not sure, [Bash versions](http://tldp.org/LDP/abs/html/bash2.html))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps "Bash 3.2+ (if you are not sure, see the Bash documentation)"?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, that link goes to an unofficial changelog between the versions of Bash. There may be inaccuracies there.

The documentation is part of Advanced Bash Scripting Guide, which was written by a guy who wanted to learn to script with bash, and so it's pointed out regularly around the web that it's not the best resource for everything. It is a very good guide, and it has received a lot of feedback and suggestions from people like Stéphane Chazelas, who seems to know everything there is to know about bash and related topics.

Anyways, I think I'd prefer it'd said Bash 3.2+ (If you aren't sure, see [the bash changelog]).

* Git 2.1+

## To submit a new command, you should

Let's assume your new command is named `foo`.

1. Write a bash script under `./bin` called `git-foo`.
2. Read `./man/Readme.md` and write documentation for `git-foo`.
3. Don't forget to introduce it in `Commands.md`.
4. Update `./etc/git-extras-completion.zsh`. Just follow existing code.
5. (Optional) Update `./etc/bash_completion.sh`.
6. Run `./check_integrity.sh foo` to check if all is done.

You are welcome to open up an issue to discuss new commands or features before opening a pull request.