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

Made first half of Contributing.md collapsable #85

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

likeajumprope
Copy link
Collaborator

Closes # .

Changes proposed in this pull request:

I have made the first half of the contributing.md file collapsable.
More changes to come.
This pull request is linked to issue #81

Copy link
Collaborator

@htwangtw htwangtw left a comment

Choose a reason for hiding this comment

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

Well done! I added something minor to address.

Comment on lines +5 to +7
<summary>
<h4>Open Issue on GitHub :ticket:</h4>
</summary>
Copy link
Collaborator

Choose a reason for hiding this comment

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

You might want to remove the line skip and make it like this:

<summary><h4>Open Issue on GitHub :ticket:</h4></summary>

If you check the rendered version, the current header are not aligned with the triangle.

@htwangtw htwangtw added the OHBM brainhack 2021 Tracking for proceeding write up label Aug 30, 2021
Copy link
Collaborator

@shawnrhoads shawnrhoads left a comment

Choose a reason for hiding this comment

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

Just noticed this PR! Yay!! This is a great idea, @likeajumprope! Thanks for incorporating! 😄

I also have a few suggestions related to how the Markdown was rendered. Let me know if you'd like any help with these!

  • Remove the line skip as suggested earlier by @htwangtw for the following lines:

    • 5-7
    • 15-17
    • 25-27
    • 47-50
    • 67-69
    • 78-80
    • 83-85
  • The content inside the <ul> and <li> tags is also coming up a bit weird for me for the following lines (should we change to Markdown?:

    • 24-42
    • 56-62
    • 82-104
  • Change the following hyperlinks to HTML (I don't think the inserting Markdown hyperlinks play nicely inside HTML tags) for the following lines:

    • 110 [Fork](https://help.github.com/articles/fork-a-repo) the [Brainhack Jupyter Book repository](https://github.com/brainhackorg/brainhack_jupyter_book) to your Github account :trident: to < a href="https://help.github.com/articles/fork-a-repo">Fork</a> the <a href="https://github.com/brainhackorg/brainhack_jupyter_book">Brainhack Jupyter Book repository</a> to your Github account :trident:
    • 124 [Clone](https://help.github.com/articles/cloning-a-repository) to <a href="https://help.github.com/articles/cloning-a-repository">Clone</a>
  • Remove indentation on line 71

  • Remove double spaces on lines:

    • 115 copy of the Brainhack Jupyter Book
    • 135 in the Brainhack Jupyter Book repository

Also, did you want the "Configuration" heading to be <h5>?

@Remi-Gau
Copy link
Member

Remi-Gau commented Dec 5, 2022

I think I will actually move the contributing to be actually a page in the jupyter book so as to make it easier to browse for users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OHBM brainhack 2021 Tracking for proceeding write up
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants