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

Closes #1301: Update CONTRIBUTING.md #1523

Merged
merged 2 commits into from
Jun 23, 2022
Merged

Closes #1301: Update CONTRIBUTING.md #1523

merged 2 commits into from
Jun 23, 2022

Conversation

stress-tess
Copy link
Member

This PR (Closes #1301) updates CONTRIBUTING.md to specify best practices for:

  • Adding issues
  • Writing code
  • Writing/running tests
  • Writing PRs
  • Merging PRs
  • Cutting releases

Ethan-DeBandi99
Ethan-DeBandi99 suggested changes Jun 22, 2022
View reviewed changes
Copy link
Contributor

@Ethan-DeBandi99 Ethan-DeBandi99 left a comment

Choose a reason for hiding this comment

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

Nothing major, just a few wording updates. This will be really helpful though.

As a general note, review text-blocks and add periods to the end if they are sentences/paragraphs.

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
mhmerrill
mhmerrill suggested changes Jun 22, 2022
View reviewed changes
Copy link
Contributor

@mhmerrill mhmerrill left a comment

Choose a reason for hiding this comment

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

looks good, just one request.

CONTRIBUTING.md Show resolved Hide resolved
joshmarshall1
joshmarshall1 reviewed Jun 22, 2022
View reviewed changes
Copy link
Contributor

@joshmarshall1 joshmarshall1 left a comment

Choose a reason for hiding this comment

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

Definitely go through and add periods to the end of sentences. I think Ethan and Mike already caught and commented on all the specific nuances though.

Closes Bears-R-Us#1301: Update CONTRIBUTING.md
8e74902 
This PR (Closes Bears-R-Us#1301) updates `CONTRIBUTING.md` to specify best practices for:
- Adding issues
- Writing code
- Writing/running tests
- Writing PRs
- Merging PRs
- Cutting releases
@stress-tess stress-tess force-pushed the 1301_update_CONTRIBUTING.md branch from c470f7a to 6b0a5d9 Compare June 22, 2022 17:05
Ethan-DeBandi99
Ethan-DeBandi99 suggested changes Jun 22, 2022
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@stress-tess stress-tess force-pushed the 1301_update_CONTRIBUTING.md branch from 6b0a5d9 to 6ca99f1 Compare June 22, 2022 21:33
@mhmerrill mhmerrill merged commit faa0779 into Bears-R-Us:master Jun 23, 2022
@stress-tess stress-tess deleted the 1301_update_CONTRIBUTING.md branch June 23, 2022 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshmarshall1 joshmarshall1 joshmarshall1 left review comments

@Ethan-DeBandi99 Ethan-DeBandi99 Ethan-DeBandi99 approved these changes

@mhmerrill mhmerrill mhmerrill approved these changes

@reuster986 reuster986 Awaiting requested review from reuster986

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

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md to specify coding standards
4 participants
@stress-tess @Ethan-DeBandi99 @mhmerrill @joshmarshall1