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] Markdown header levels need to be corrected (28 PRs for HacktoberFest participants) #1321

Open
28 tasks done
BrainonSilicon opened this issue Sep 9, 2020 · 7 comments
Open
28 tasks done
Labels
good first issue Good issue for newcomers to fix or respond to Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors.

Comments

@BrainonSilicon
Copy link
Collaborator

BrainonSilicon commented Sep 9, 2020

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

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

About Hacktober and The Turing Way

Hacktober 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.

Under the Issues listed in our Hacktober tag, we’ve outlined what needs to be done, and how you can go about addressing it. Once the Issue has been addresses, 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 is easy for you to find 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

Please read our core Contributors document and our Code of Conduct while you engage in The Turing Way. We want to ensure that every user and contributor feels welcome, included and supported to participate in The Turing Way community.

In addition, for Hacktober we would also like to recognise the work that you are doing. If you would like to be featured on our Twitter Hacktoberfest series then:

  • Add your twitter handle to the comments when you submit your PR,
  • What brings you to Open Source, Hacktoberfest, and/or The Turing Way,
  • and anything else you’d like to celebrate about your contribution!

We welcome all contributions to this project via GitHub issues and pull requests. Please follow these guidelines to make sure your contributions can be easily integrated into the projects. 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.

Summary of Issue

There are non-consecutive header levels (eg. level 0 to 2, or 1 to 3). Below are listed the current places where this occurs.

When the issue lists "Non-consecutive header level increase; 0 to 2", it expects headers to follow # (a level 0 header), ## (a level 1 header), ### (a level 2 header) sequence. So we would love contributors to change the headers to follow (header 0, header 1, header 2, and so on).

What needs to be done

Please select 1-2 of these to fix, open a separate issue, make a PR with the fixed headers, and enjoy your Hacktober!

Note: if there are multiple instances then it means that there are multiple headers that need to be fixed within that book.

List of Non-consecutive header levels 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

@BrainonSilicon BrainonSilicon added good first issue Good issue for newcomers to fix or respond to Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. labels Sep 9, 2020
@welcome
Copy link

welcome bot commented Sep 9, 2020

Welcome Banner
πŸŽ‰ Welcome to The Turing Way! πŸŽ‰ We're really excited to have your input into the project! πŸ’–

If you haven't done so already, please make sure you check out our Contributing Guidelines and Code of Conduct. If you need to connect more synchronously with members of The Turing Way community, please feel free to chat with us in our gitter channel, or you can join our Collaboration Cafe for mentored contribution or co-working.

@BrainonSilicon BrainonSilicon changed the title [BUG] Non-consecutive heads [BUG] Non-consecutive headers Sep 9, 2020
@malvikasharan malvikasharan changed the title [BUG] Non-consecutive headers [BUG] Non-consecutive headers ( 28 PRs for HacktoberFest participants) Sep 25, 2020
@malvikasharan malvikasharan changed the title [BUG] Non-consecutive headers ( 28 PRs for HacktoberFest participants) [BUG] Non-consecutive headers (28 PR ideas for HacktoberFest participants) Sep 25, 2020
@malvikasharan malvikasharan changed the title [BUG] Non-consecutive headers (28 PR ideas for HacktoberFest participants) [BUG] Markdown header levels need to be corrected (28 PRs for HacktoberFest participants) Oct 2, 2020
@KirstieJane
Copy link
Collaborator

Hi @BrainonSilicon! I'm just having a look at this issue with @MariaEriksson and I'm a little confused 😬

I'm looking at the first example in the list above:

Non-consecutive header level increase; 0 to 2 https://github.com/alan-turing-institute/the-turing-way/blob/master/book/website/community-handbook/acknowledgement/acknowledgement-examples.md

In that file the first line is: ## Different Contributions and their Acknowledgements

and then the next header down is ### Bug fixing

Is the activity to move the first one to just one # (a level 0 header) and the second to ## (a level 1 header)? I think I got a bit lost with the "0 to 2" part of the bullet point above.

Thank you for your help!

@BrainonSilicon
Copy link
Collaborator Author

Hi @BrainonSilicon! I'm just having a look at this issue with @MariaEriksson and I'm a little confused 😬

I'm looking at the first example in the list above:

Non-consecutive header level increase; 0 to 2 https://github.com/alan-turing-institute/the-turing-way/blob/master/book/website/community-handbook/acknowledgement/acknowledgement-examples.md

In that file the first line is: ## Different Contributions and their Acknowledgements

and then the next header down is ### Bug fixing

Is the activity to move the first one to just one # (a level 0 header) and the second to ## (a level 1 header)? I think I got a bit lost with the "0 to 2" part of the bullet point above.

Thank you for your help!

Hi @KirstieJane. Thank you for clarifying - I'll update the issue so that it's clearer.

I believe that the bug came from expecting a # (level 0) first, followed by a ## (level 1).

Does that make it clearer?

@MariaEriksson
Copy link
Collaborator

Hey @BrainonSilicon! Thanks for explaining πŸ™ I'd love to try to make these changes - I'm just still very new to GitHub, so could I please double check that I've understood how to do this? For instance, for the example

Non-consecutive header level increase; 0 to 2 https://github.com/alan-turing-institute/the-turing-way/blob/master/book/website/community-handbook/acknowledgement/acknowledgement-examples.md

would I open this example on its own, select Edit this file, make the change, and then Commit the changes(which would create a new pull request)? Or would I tick several examples, and then select New Issue? I got a bit confused by the instructions 😬

@BrainonSilicon
Copy link
Collaborator Author

BrainonSilicon commented Oct 14, 2020

No worries! We are also currently working on separating out this issue into smaller ones (see the new issue 1398 here for a further explanation). So no worries at all.

For this Issue, you were spot on with your first comment!

What to do is:

  • choose which bugs you want to fix (from the list)
  • follow the link to the file
  • find the corresponding bug
  • select Edit this file
  • then Commit the Changes with a comment. This is done on "your" branch.
  • you will then have a screen titled Open Pull Request where you can write more about what you've done
  • there is then a Pull Request button which officially makes your Pull Request
  • we can then review your changes, check any conflicts, and give feedback

Let me know if that is clear, there are community coworking hours tomorrow and I would be happy to walk through with you or comment further (and a massive thank you for contributing to The Turing Way!!)

@malvikasharan
Copy link
Collaborator

malvikasharan commented Oct 15, 2020

I have created dedicated issues for each file with header problem. Hoping that making it modular will attract newer contributors.

@MariaEriksson
Copy link
Collaborator

Thanks again @BrainonSilicon! I've given the two first issues a try - hopefully, they look ok! And if they do, I'll do more πŸ‘ If I do do more, I assume I should open the 'dedicated issues' that you have created @malvikasharan, instead of opening the issues listed on this page? And does this mean that I should re-do the issues I did, now that they have become 'dedicated issues'?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good issue for newcomers to fix or respond to Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors.
Projects
None yet
Development

No branches or pull requests

4 participants