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

Fix #4447 Fix #3987 Fix #3755 merge README into CONTRIBUTING and document deploy process #4449

Merged
merged 16 commits into from
Jun 21, 2024

Conversation

jimmyli97
Copy link
Contributor

Resolves #4447 Resolves #3987
Together with #3766 resolves #3755

Description

  • Removes duplication from README and CONTRIBUTING by merging all contribution guidelines from README into CONTRIBUTING
  • Clarifies to run bundle exec rake and bin/lint before pull requests
  • Fix dead links in sbv.md
  • Document date-based versioning deploy process

Additional changes:

  • Fix slack link in CONTRIBUTING
  • Write contribution guidelines in more of a table-of-contents style with a general overall workflow checklist which links to more details
  • Added a note about using binding.pry in rspec for specific line numbers
  • Added a note about what automated tests run on pull request
  • Use git push origin tag <tagname> instead of git push --tags, see this SO post for why

Motivation

Basically what I mentioned in #4447, the duplication of guidelines is a bit confusing as well as the conflicting information about what to run before making a pull request. Also, I wanted a checklist that I could glance at to make sure I did everything correctly.

Type of change

  • Documentation update

How Has This Been Tested?

Opened README and CONTRIBUTING and SBV in browser

Copy link
Collaborator

@dorner dorner left a comment

Choose a reason for hiding this comment

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

I'm OK with this, other than one comment. @awwaiid did you want to take a look?

CONTRIBUTING.md Outdated
end
```

## Deployment Process
Copy link
Collaborator

Choose a reason for hiding this comment

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

This isn't part of the contribution guidelines, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's in the README at the bottom in the master repository and issue #3987 said to document the deploy process, so I figured I would put it in CONTRIBUTING. Should I put it back in the README? Or delete it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's put it back in the README.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

resolved by 9cb04c1

@jimmyli97 jimmyli97 requested a review from dorner June 20, 2024 15:49
@dorner dorner merged commit 43c751e into rubyforgood:main Jun 21, 2024
1 check passed
@dorner
Copy link
Collaborator

dorner commented Jun 21, 2024

Thanks!

Copy link
Contributor

@jimmyli97: Your PR Fix #4447 Fix #3987 Fix #3755 merge README into CONTRIBUTING and document deploy process is part of today's Human Essentials production release: 2024.06.23.
Thank you very much for your contribution!

@jimmyli97 jimmyli97 deleted the 4447-3987-3755-update-docs branch June 26, 2024 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants