MAINT: update README for standard format #147
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for incomparable-parfait-2417f8 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Thanks @mmcky . It would be great to standardize README files and .gitignores, although I realize it's not easy. |
|
@jstac is there anything else you think should be in (or out) of the README. Currently I have included |
jstac
reviewed
Mar 7, 2024
README.md
Outdated
| 1. JS to-do: prioritize lectures | ||
| 1. Suggest a benchmark example that we can build off | ||
| 1. We will probably think differently about how to approximate and optimize | ||
| To contribute to the lectures please [raise an issue](https://github.com/QuantEcon/lecture-jax/issues) for any errata |
There was a problem hiding this comment.
To make it more generic and easier to copy and paste:
## Contributions
To comment on the lectures please add to or open an issue in the issue tracker (see above).
We welcome pull requests! Please read the [QuantEcon style guide](https://manual.quantecon.org/intro.html) first, so that you can match our style.
There was a problem hiding this comment.
Thanks @jstac I think this is a great suggestion.
|
Looks good, made a minor suggestion above. |
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the readme to move towards a standardized style across the lectures.
@jstac comments on this README I will capture for the
.github/lectures/README.mdtemplate that I will then add to the QuantEcon manual to use when building a lecture repo.see QuantEcon/meta#132