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

Add CONTRIBUTING.md and CODE_OF_CONDUCT.md #434

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

robotdana
Copy link
Contributor

No description provided.

@robotdana robotdana force-pushed the dana/CONTRIBUTING.md branch 5 times, most recently from 6ba9221 to 40e9bee Compare May 5, 2023 05:35
Copy link
Contributor

@G-Rath G-Rath left a comment

Choose a reason for hiding this comment

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

I jumped the gun and started reviewing early - I'm going to post these so they don't get eaten by further changes, and then can re-review when you're actually ready for that.

fwiw I personally feel a bit eh about using this code of conduct because of the prior history/controversy, but expect I'm in the minority and I know Ruby use it so 🤷

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
@robotdana robotdana force-pushed the dana/CONTRIBUTING.md branch 5 times, most recently from 8c96973 to 0cac6d7 Compare May 5, 2023 05:50
uses: ruby/setup-ruby@v1
with:
bundler-cache: true
ruby-version: '3.0'
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably use a `.ruby-version file for this so it is consistent with local dev.

Also we should remove TargetRubyVersion from this repo's .rubocop.yml so that Rubocop can pick up .ruby-version too - see https://docs.rubocop.org/rubocop/configuration.html#setting-the-target-ruby-version

Copy link
Contributor

Choose a reason for hiding this comment

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

🐘 ideally I'd prefer this change be done in its own PR :)

Also we should remove TargetRubyVersion from this repo's .rubocop.yml

I don't think it matters that much, but fwiw I thought the comment on why that is in there made sense ("Target the oldest version of Ruby that Rails 7 supports")

@eoinkelly
Copy link
Contributor

Docs look good to me, just one small thing about the rubocop CI change

Comment on lines +119 to +121
- Use well-crafted commit messages, providing context if possible.
- Squash "WIP" commits and remove merge commits by rebasing your branch against
`main`. We try to keep our commit history as clean as possible.
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we merge by squashing, I think we should be saying roughly the opposite: while a tidy commit history is useful (especially for large changes), it doesn't have to be perfect since we'll squash everything into one, but what we do want is a meaningful PR title & description.

finishes with `.tt`, Thor considers it to be a template and places it in the
destination without the extension `.tt`.

## Tests
Copy link
Contributor

Choose a reason for hiding this comment

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

This section feels unfinished to me - notably, I don't think it correctly explains that:

  1. we have a collection of configs that are run by CI
  2. these live in ci/configs
  3. ci/bin/build-and-test can be used to run one of these configs

CONTRIBUTING.md Outdated Show resolved Hide resolved
@lukeify lukeify changed the title Add CONTRBITUTING.md and CODE_OF_CONDUCT.md Add CONTRIBUTING.md and CODE_OF_CONDUCT.md May 23, 2023
@eoinkelly eoinkelly added the WIP Work in progress label Oct 21, 2023
@G-Rath G-Rath force-pushed the dana/CONTRIBUTING.md branch from a7d0286 to c05e0eb Compare November 17, 2023 21:32
@G-Rath G-Rath marked this pull request as draft November 17, 2023 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants