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

adding code structure and moving contributing guide #394

Merged
merged 4 commits into from
Oct 11, 2019

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Oct 10, 2019

This PR does two things:

  • Adds a section on code repository structure to the contributing guide. The goal is to explain the general layout of major pieces of the repository to help people get situated better.
  • Moves the contributing guide so that it's a page in the Jupyter Book documentation, and links the CONTRIBUTING.md file to that page, in the hopes that it makes the page more discoverable.

@emdupre did all the hard work getting this guide up in the first place, so I'd love to hear what she think about this move!

Here's a link to the contributing guide page: https://deploy-preview-394--jupyter-book.netlify.com/contributing.html

and here's a link to the new section: https://deploy-preview-394--jupyter-book.netlify.com/contributing.html#Repository-Structure-of-Jupyter-Book

Copy link
Collaborator

@emdupre emdupre left a comment

Choose a reason for hiding this comment

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

This looks great 🚀

I had a few formatting questions, but I agree that this should increase visibility of these guidelines ! Thanks for making the switch.

jupyter_book/book_template/content/contributing.md Outdated Show resolved Hide resolved
jupyter_book/book_template/content/contributing.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved

The current list of labels are [here][link_labels] and include:

* [![Help Wanted](https://img.shields.io/badge/-help%20wanted-159818.svg)][link_helpwanted] *These issues contain a task that a member of the team has determined we need additional help with.*
Copy link
Collaborator

Choose a reason for hiding this comment

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

For some reason the rendering of these badges is off -- they're floating in the center of the page (and by "for some reason" I mean "I think because of our CSS rules"). I don't love how they look as a result. WDYT of removing them ?

@emdupre emdupre mentioned this pull request Oct 11, 2019
choldgraf and others added 2 commits October 11, 2019 09:29
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
@choldgraf
Copy link
Member Author

Good catch @emdupre - I merged in your commits, and the latest push tries to fix the issue w/ inline images. I think this was worth fixing here, because that issue was going to be the case for anybody that applied an inline image, which doesn't seem great :-P

Take a look and LMK what you think!

@emdupre
Copy link
Collaborator

emdupre commented Oct 11, 2019

Looks great ! Good call on not just giving up on the inline images 😅 they look perfect, now.

@choldgraf choldgraf merged commit 4fc0e19 into executablebooks:master Oct 11, 2019
@choldgraf choldgraf deleted the developer_guide branch October 11, 2019 21:31
@choldgraf
Copy link
Member Author

yay! 🎉

@choldgraf choldgraf added the documentation Something related to the documentation label Oct 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants