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 contributor guide #500

Merged
merged 46 commits into from
Oct 3, 2023
Merged

Conversation

jrhemstad
Copy link
Collaborator

@jrhemstad jrhemstad commented Sep 27, 2023

Description

Depends on #481

closes #499

Provides a comprehensive guide for CCCL contributors. Updates the ci-overview.md to cover fewer implementation details and more general stuff.

@jrhemstad jrhemstad changed the base branch from main to contributor-guide September 27, 2023 15:24
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

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

Some comments. I’d be okay with slimmer guides in general. I think some areas are a little too heavy on information. (Should CCCL teach contributors how to fork / clone / make a PR, or should it link to an external guide that covers that information?)

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
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
jrhemstad and others added 2 commits September 29, 2023 13:35
Co-authored-by: Bradley Dice <[email protected]>
Co-authored-by: Vyas Ramasubramani <[email protected]>
Co-authored-by: Allard Hendriksen <[email protected]>
@jrhemstad jrhemstad requested a review from miscco October 2, 2023 14:50
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

This looks really good! Nothing to add really aside from what other reviewers already mentioned, except that some of the info regarding our general GHA processes (e.g. copy-pr-bot and ok to test) could be reduced even further to just links, but I see the argument for providing at least some basic info about those in this document.

@jrhemstad jrhemstad changed the base branch from contributor-guide to main October 3, 2023 21:52
@jrhemstad jrhemstad requested a review from a team as a code owner October 3, 2023 21:52
@jrhemstad jrhemstad requested review from jarmak-nv and removed request for a team October 3, 2023 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add contributor guide
6 participants