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

[BUG] Fix Markdown formatting of non-consecutive headers: Open Data subchapter #1407

Closed
1 task done
malvikasharan opened this issue Oct 15, 2020 · 1 comment Β· Fixed by #1483
Closed
1 task done

[BUG] Fix Markdown formatting of non-consecutive headers: Open Data subchapter #1407

malvikasharan opened this issue Oct 15, 2020 · 1 comment Β· Fixed by #1483
Labels
bug Something isn't working good first issue Good issue for newcomers to fix or respond to Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. markdown These issues or PR are related to a Markdown format file.

Comments

@malvikasharan
Copy link
Collaborator

malvikasharan commented Oct 15, 2020

πŸŽ‰πŸŽˆπŸ° Welcome Hacktober Contributors! This is The Turing Way repository πŸ°πŸŽˆπŸŽ‰

πŸ’«πŸ₯β˜€οΈ We're excited that you're here and want to contribute. β˜€οΈπŸ₯πŸ’«

Summary of Issue

The Turing Way chapters are written in MarkDown format. Each chapter has a header (top-level header denoted by single # - h1 tag) and subheaders (## - h2, ### - h3, #### - h4 tags).

A standard expected format should follow # (h1 tag) -> ## (h2 tag) -> ### (h3 tag) and so on in sequence.

What needs to be done

The Open Research's subchapters have non-consecutive header levels (instead of starting from h1, they start at h2, or some chapters have h1->h3, or h2->h4 instead of h1->h2->h3->h4 headers) which needs to be fixed.

Who can help

Anyone who would like to participate in Hacktoberfest or contribute to The Turing Way GitHub repository for the first time easier to do locally (by git) but not mandatory

About Hacktober and The Turing Way

Hacktoberfest is a month-long celebration of Open Source Projects where the goal is to make 4 Pull Requests during the month.

A bit about Git

If you’re new to git then here are some instructions to help you get going. Remember that you can ask us any questions you need to along the way.

A Pull Request (what Hacktober is measured on) lets you tell others about changes you've pushed to a branch in a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.

In this issue, we’ve outlined what needs to be done, and how you can go about addressing it. Once the issue has been addressed, you can submit a Pull Request for review (tell us what you’ve done) and we can incorporate it into The Turing Way.

We’ve also created this special Hacktoberfest tag to make it easy for you to find other places to contribute if you’re new.
In the spirit of Hacktoberfest, please only do a few of these to submit your PR so that we can learn and grow as a community together.

Our Community

We want to ensure that every user and contributor feel welcome, included, and supported to participate in The Turing Way community. We welcome all contributions to this project via GitHub issues and pull requests. Please read our Contributors document and our Code of Conduct while you engage in The Turing Way. As you start contributing to The Turing Way, don't forget that your ideas are more important than perfect pull requests. ❀️

If you have any questions that aren't discussed below, please let us know through one of the many ways to get in touch.

@malvikasharan malvikasharan added bug Something isn't working Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. markdown These issues or PR are related to a Markdown format file. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. labels Oct 15, 2020
@malvikasharan malvikasharan changed the title [BUG] Fix Markdown formatting of non-consecutive headers [BUG] Fix Markdown formatting of non-consecutive headers: Open Data subchapter Oct 15, 2020
@malvikasharan malvikasharan added the good first issue Good issue for newcomers to fix or respond to label Oct 15, 2020
@ikayz
Copy link
Contributor

ikayz commented Oct 29, 2020

@malvikasharan I would like to work on this issue too 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good issue for newcomers to fix or respond to Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. markdown These issues or PR are related to a Markdown format file.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants