X Tutup
Skip to content

Add first draft of contributing.md#182

Closed
leereilly wants to merge 598 commits intomasterfrom
draft-contributing-md
Closed

Add first draft of contributing.md#182
leereilly wants to merge 598 commits intomasterfrom
draft-contributing-md

Conversation

@leereilly
Copy link
Copy Markdown
Contributor

@leereilly leereilly commented Dec 19, 2019

Closes #191

This PR adds a modified version of our contributing.md template under the .github directory.

Note: It looks like there's a todo item to discuss the project's contribution philosophy, so I suspect this will change.

Amanda Pinsker and others added 30 commits December 3, 2019 08:58
Support `-a, --assignee` in `pr list`
Also validates that the issue passed either by number or by URL exists.
- Only report an update available if the version number of the release
  is greater than the current version

- Removes `command` dependency from `update` package; instead, pass
  current version as an argument

- Remove `brew upgrade` instructions since we can't be certain that gh
  was installed via Homebrew in the first place.

- Does not check for updates unless stderr is a tty

- Preserve stderr color output even if stdout is not a tty

- Fixes stderr color output on Windows
To test the update notifier:

    rm -f bin/gh; GH_VERSION=v0.2.3 LDFLAGS='-X main.updaterEnabled=github/homebrew-gh' make
- Individual components are now colored
- We don't say "Release notes" anymore since the URL doesn't contain
  any release notes yet
- Check for updates even if `~/.config/gh` does not exist. In this case,
  the API call is unauthenticated.

- Avoid having the update notifier ever triggering the OAuth flow.
Add alert text for users to update gh
Add google form link to root help description
Support issue/PR URLs & PR branch names passed as arguments
Nate Smith and others added 2 commits January 22, 2020 15:45
Co-Authored-By: Lee Dohm <1038121+lee-dohm@users.noreply.github.com>
@vilmibm
Copy link
Copy Markdown
Contributor

vilmibm commented Jan 22, 2020

Incorporated feedback from slack. Will wait on a @billygriffin sign-off.


Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we say “adheres to” instead? Since “released” was used in the last paragraph in an entirely different (i.e. legal) context

Suggested change
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
Please note that this project adheres to [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.

0. Make your change, add tests, and make sure the tests still pass
0. Link your PR to any relevant issue it addresses
0. Push to your fork and [submit a pull request][pr]
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

“Pat yourself on the back” is the colloquialism that I was referring to at sync, sometimes even used in a derogatory context. Since the list is already pretty long, we can maybe drop this item, because the contributor is done with her part!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

agreed!


## Submitting a pull request

0. [Fork][fork] and clone the repository
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If we wanted to guide users to using gh for contributions, should we tell them to clone, not fork, this repository and later use gh pr create for forking + pushing? It might be neat 😉

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

that occurred to me, but seemed like if someone was trying to fix a bug that prevented them from using gh in the first place it might be a bit rude 😓

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i thought about it more and couldn't resist; it's too cute. just pushed a commit with instructions using gh pr create.

[pr]: https://github.com/cli/cli/compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

“essential to” is to go before verbs

Suggested change
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential to keeping it great.

Copy link
Copy Markdown
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you so much

[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Hi! Thanks for your interest in contributing to `gh`!
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we say “GitHub CLI” (the project) instead of gh (the command)?

building out what we see as key features and plan to test out a lot of hypotheses about how we can
make working with GitHub from the CLI great. As such, **we are not currently accepting PRs that implement
large, new features** or make significant changes to existing featues.
Given the beta status of this work, we're only accepting PRs for bug fixes right now. We'd love to
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we say "pull requests" instead of PRs, similarly to how we do in gh's own interface?

We _do_ encourage opening issues to propose ideas for discussion and are excited to take PRs for bug
fixes or documentation updates. Once `gh` is a more established tool with clear usage patterns we
may change this policy.
Please do:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Love it!! ❤️

@vilmibm
Copy link
Copy Markdown
Contributor

vilmibm commented Jan 22, 2020

heya @leereilly ! I took a swing at drafting this according to our team stance on contributions. What do you think?

@mislav mislav closed this Jan 23, 2020
@mislav mislav force-pushed the draft-contributing-md branch from cf1cb6a to 064cadb Compare January 23, 2020 17:29
@mislav mislav mentioned this pull request Jan 23, 2020
@mislav
Copy link
Copy Markdown
Contributor

mislav commented Jan 23, 2020

Sorry, that this got prematurely closed, everyone. I was scrubbing large blobs from repo history and had to force-push all existing branches. This led to this PR being auto-closed. I've opened the new PR with the latest state of this branch here: #252

cchristous pushed a commit to cchristous/cli that referenced this pull request Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

create CONTRIBUTING.md

10 participants

X Tutup