-
Notifications
You must be signed in to change notification settings - Fork 42
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
Conversation
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
It may be good to have this be a more traditional 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 |
@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 |
I'm fine to keep the current content, but I would like if we could rename this to @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]>
99139bc
to
cbf7c62
Compare
@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! |
Thanks for the reviews! |
This isn't exhaustive, but should give a basic starting point for anyone wanting to work on SDG locally.