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

Jump to bottom

Update Contributing.md and add information about ADR's #383

Merged
merged 5 commits into from
Mar 17, 2020
Merged

Update Contributing.md and add information about ADR's #383

merged 5 commits into from
Mar 17, 2020

Conversation

thboop
Copy link
Collaborator

@thboop thboop commented Mar 16, 2020 •
edited
Loading

We wanted to:

  • Rename contribute.md and place it in the correct location show github shows it for new developers
  • Updating the contributing.md to mention our development process around adrs

@thboop thboop force-pushed the users/thboop/updatingContributing.md branch from c3edfb6 to c962b3e Compare March 16, 2020 20:41
thboop
thboop commented Mar 16, 2020
View reviewed changes
.github/CONTRIBUTING.md Outdated
@@ -1,3 +1,24 @@
# Contributions

We welcome contributions in the form of issues and pull requests. We view the contributions and the process as the same for github and external contributors.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hard to see changes, look for it commit by commit: c962b3e

ericsciple
ericsciple reviewed Mar 17, 2020
View reviewed changes
.github/CONTRIBUTING.md Outdated

We ask that before significant effort is put into code changes, that we have agreement on taking the change before time is invested in code changes.

1. Create a feature request. Once agreed we will take the enhancment
Copy link
Contributor

Choose a reason for hiding this comment

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

Once agreed we will take the enhancement

I first read that sentence to mean, "Once agreed, we will implement the enhancement (your part is over)"

I am now wondering whether it was an incomplete sentence. "Once agreed we will take the enhancement, ____"

ericsciple
ericsciple reviewed Mar 17, 2020
View reviewed changes
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
ericsciple
ericsciple reviewed Mar 17, 2020
View reviewed changes
.github/CONTRIBUTING.md Outdated
@@ -1,3 +1,24 @@
# Contributions

We welcome contributions in the form of issues and pull requests. We view the contributions and the process as the same for github and external contributors.
Copy link
Contributor

Choose a reason for hiding this comment

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

We view the contributions and the process as the same for github and external contributors.

Consider removing the sentence. Might be confusing what "github" contributors are vs "external" - overwhelming majority of folks reading will be external. Feels unnecessary and a lot to untangle, especially in the intro.

Otherwise consider removing extra "the" and changing "github" to "internal" or "GitHub":

We view the contributions and the process as the same for github internal and external contributors.

@thboop thboop merged commit 12f3011 into master Mar 17, 2020
@thboop thboop deleted the users/thboop/updatingContributing.md branch March 17, 2020 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericsciple ericsciple ericsciple approved these changes

@bryanmacfarlane bryanmacfarlane Awaiting requested review from bryanmacfarlane

@konradpabjan konradpabjan Awaiting requested review from konradpabjan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@thboop @ericsciple