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

Contribution guidelines v2 #560

Merged
merged 8 commits into from
Sep 14, 2023
Merged

Contribution guidelines v2 #560

merged 8 commits into from
Sep 14, 2023

Conversation

symbolpunk
Copy link
Contributor

@symbolpunk symbolpunk commented Sep 14, 2023 •
edited
Loading

  • updates guidance to reflect current organization
  • simplifies headers
  • clarifies purpose of 3p docs
  • introduces a dedicated "third-party documents" node & guide in the devdocs section using partial views - this will give our contributors a clear place to add their docs without having to create the 3p node themselves

Previews:

@cla-bot cla-bot bot added the s label Sep 14, 2023
@vercel
Copy link

vercel bot commented Sep 14, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nitro-docs ✅ Ready (Inspect) Visit Preview Sep 14, 2023 11:34pm

@symbolpunk symbolpunk changed the title Contribution guidelines - pulling up to latest organization, tidying up headers, clarifying purpose of 3p docs Contribution guidelines v2 Sep 14, 2023
@symbolpunk symbolpunk marked this pull request as ready for review September 14, 2023 22:55
hkalodner
hkalodner reviewed Sep 14, 2023
View reviewed changes
Copy link
Contributor

@hkalodner hkalodner left a comment

Choose a reason for hiding this comment

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

I like the improvements overall, but I'm a bit concerned about the duplication between contribute and third party contribute being confusing. What do you think about cross linking more vs partial inclusion. I can definitely see the upside of the partials that everything you need is in one doc, but personally I'd guess as somebody external I'd be a bit confused

arbitrum-docs/partials/_contribute-core-docs-partial.md Outdated Show resolved Hide resolved
arbitrum-docs/partials/_contribute-core-docs-partial.md Outdated Show resolved Hide resolved
hkalodner
hkalodner approved these changes Sep 14, 2023
View reviewed changes
Copy link
Contributor

@hkalodner hkalodner left a comment

Choose a reason for hiding this comment

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

LGTM

@symbolpunk symbolpunk merged commit 505c92c into master Sep 14, 2023
2 checks passed
@symbolpunk symbolpunk deleted the 3p-guidance-updates branch September 14, 2023 23:38
@ThirawatChuaiklang ThirawatChuaiklang mentioned this pull request Sep 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hkalodner hkalodner hkalodner approved these changes

@mahsamoosavi mahsamoosavi Awaiting requested review from mahsamoosavi

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

Successfully merging this pull request may close these issues.
2 participants
@symbolpunk @hkalodner