Update user guide contributing docs #330
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
IAlibay
reviewed
Sep 29, 2023
IAlibay
reviewed
Oct 1, 2023
RMeli
reviewed
Oct 1, 2023
|
@lilyminium is this PR still relevant? |
orbeckst
approved these changes
Jul 17, 2024
Co-authored-by: Rocco Meli <[email protected]> Co-authored-by: Irfan Alibay <[email protected]>
orbeckst
reviewed
Jul 17, 2024
add link for pre-commit as requested by @RMeli
|
@lilyminium if you can confirm that the PR is still relevant then let's merge it. |
|
Once osmart/hole2#19 is merged, it will be sufficient to just link to the hole2 GH README for installation instructions and we can keep our UG lighter dd8000e |
Closed
|
Yep, this is still relevant, and I just made some minor changes in response to reviews -- thanks for having a look at this everyone! |
RMeli
approved these changes
Jul 17, 2024
Co-authored-by: Rocco Meli <[email protected]>
- trim trailing whitespace - fix end of files
|
I am merging as it's (1) approved and (2) a big improvement over what we have. If there are any updates to be made, we can do them incrementally. |
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.
Related to #327
This PR removes some old section and adds some information on which files are Jupyter notebooks and which are not.
📚 Documentation preview 📚: https://mdanalysisuserguide--330.org.readthedocs.build/en/330/