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

Update CONTRIBUTING.md #2411

Merged
merged 12 commits into from
Oct 4, 2023
Merged

Update CONTRIBUTING.md #2411

merged 12 commits into from
Oct 4, 2023

Conversation

sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Oct 4, 2023

I noticed we don't mention forking anywhere in our CONTRIBUTING.md, it says to just clone the repo directly, which is not really how it works.

  • Updated/removed outdated instructions.
  • Added more details/explanation on the contributing process (forking, editable mode, etc.).
  • Moved the Releasing section to the very end since it's not relevant for community contributors.
  • ...and more.

Rendered file: https://github.com/getsentry/sentry-python/blob/54931541f6255c4e73bd8232e21b7c06bad7508f/CONTRIBUTING.md

@sentrivana sentrivana marked this pull request as ready for review October 4, 2023 09:17
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
CONTRIBUTING.md Show resolved Hide resolved
Copy link
Member

@szokeasaurusrex szokeasaurusrex 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 overall, but I added some suggestions that I think would make this file even clearer

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
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
Ivana Kellyerova and others added 4 commits October 4, 2023 15:46
Co-authored-by: Michi Hoffmann <cleptric@users.noreply.github.com>
Co-authored-by: Daniel Szoke <szokeasaurusrex@users.noreply.github.com>
Co-authored-by: Michi Hoffmann <cleptric@users.noreply.github.com>
Copy link
Member

@szokeasaurusrex szokeasaurusrex 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 to merge -- I added two more small changes to consider

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Ivana Kellyerova and others added 2 commits October 4, 2023 16:24
Co-authored-by: Daniel Szoke <szokeasaurusrex@users.noreply.github.com>
@sentrivana sentrivana enabled auto-merge (squash) October 4, 2023 14:27
@sentrivana sentrivana merged commit 59a67d3 into master Oct 4, 2023
279 checks passed
@sentrivana sentrivana deleted the ivana/improve-readme branch October 4, 2023 14:38
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.

None yet

3 participants