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 a CONTRIBUTING.md with basic dev setup instructions #470

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

bbrowning
Copy link
Contributor

This isn't exhaustive, but should give a basic starting point for anyone wanting to work on SDG locally.

@mergify mergify bot added the documentation Improvements or additions to documentation label Jan 9, 2025
@bbrowning
Copy link
Contributor Author

I've had a couple of people need to know how to get SDG setup for local development in the last few days, so it's time to add something to our repo to point them in the right direction.

@bbrowning bbrowning requested a review from a team January 9, 2025 21:15
DEVELOPMENT.md Outdated Show resolved Hide resolved
Copy link
Member

@RobotSail RobotSail left a comment

Choose a reason for hiding this comment

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

LGTM

@mergify mergify bot added the one-approval label Jan 9, 2025
@nathan-weinberg
Copy link
Member

It may be good to have this be a more traditional CONTRIBUTING.md

We have a general one of these in the Community repo: https://github.com/instructlab/community/blob/main/CONTRIBUTING.md

And also one in the Core repo: https://github.com/instructlab/instructlab/blob/main/CONTRIBUTING/CONTRIBUTING.md

@RobotSail
Copy link
Member

@nathan-weinberg I do like the format of the files you've linked and find them to be comprehensive, though I've also found the simple format of DEVELOPMENT.md presented here to be be very readable and simple for just getting started.

DEVELOPMENT.md Outdated Show resolved Hide resolved
@nathan-weinberg
Copy link
Member

@nathan-weinberg I do like the format of the files you've linked and find them to be comprehensive, though I've also found the simple format of DEVELOPMENT.md presented here to be be very readable and simple for just getting started.

I'm fine to keep the current content, but I would like if we could rename this to CONTRIBUTING.md for cross-project consistency

@bbrowning wdyt?

This isn't exhaustive, but should give a basic starting point for
anyone wanting to work on SDG locally.

Signed-off-by: Ben Browning <[email protected]>
@bbrowning bbrowning changed the title Add a DEVELOPMENT.md with basic dev setup instructions Add a CONTRIBUTING.md with basic dev setup instructions Jan 10, 2025
@bbrowning
Copy link
Contributor Author

@nathan-weinberg That was just an old habit of mine to call this DEVELOPMENT.md - renamed to CONTRIBUTING.md for consistency. Thanks for catching that!

@mergify mergify bot merged commit 1c54405 into instructlab:main Jan 10, 2025
7 checks passed
@mergify mergify bot removed the one-approval label Jan 10, 2025
@bbrowning bbrowning deleted the add-development-md branch January 10, 2025 16:38
@bbrowning
Copy link
Contributor Author

Thanks for the reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants