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

[Doc] Add developer notes #774

Merged

Conversation

riedgar-ms
Copy link
Collaborator

@riedgar-ms riedgar-ms commented Apr 23, 2024

Expand the CONTRIBUTING file to describe the basic developer setup. Since our workflows access some quite expensive resources, PRs have to be approved to run. This will let contributors get feedback faster.

@codecov-commenter
Copy link

codecov-commenter commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.39%. Comparing base (c23c8b0) to head (40b12e0).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #774      +/-   ##
==========================================
- Coverage   68.87%   62.39%   -6.49%     
==========================================
  Files          55       55              
  Lines        4071     4071              
==========================================
- Hits         2804     2540     -264     
- Misses       1267     1531     +264     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Harsha-Nori
Copy link
Collaborator

Thoughts on extending CONTRIBUTING.MD with this info instead of having a new top level file here?

@riedgar-ms
Copy link
Collaborator Author

Thoughts on extending CONTRIBUTING.MD with this info instead of having a new top level file here?

That's an option too. I thought about it, but the existing file was more 'legalese' than information on how to contribute. Happy to switch if you prefer.

DevelopmentNotes.md Outdated Show resolved Hide resolved
@riedgar-ms
Copy link
Collaborator Author

riedgar-ms commented Apr 24, 2024

@Harsha-Nori , I've moved everything into CONTRIBUTING. I've also added some notes about how to hook new models into the testing setup on the off chance that random people feel inspired to push to main.

@riedgar-ms riedgar-ms merged commit f5ad01d into guidance-ai:main Apr 26, 2024
96 checks passed
@riedgar-ms riedgar-ms deleted the riedgar-ms/development-notes-01 branch April 26, 2024 01:22
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