Skip to content

docs(contribute): adds table of contents and info about dependencies.#842

Merged
ematipico merged 4 commits into
webpack:masterfrom
pranshuchittora:docs-contribute
Apr 23, 2019
Merged

docs(contribute): adds table of contents and info about dependencies.#842
ematipico merged 4 commits into
webpack:masterfrom
pranshuchittora:docs-contribute

Conversation

@pranshuchittora

@pranshuchittora pranshuchittora commented Apr 20, 2019

Copy link
Copy Markdown
Contributor
  • Adds Table of Contents.
  • Adds a section about dependencies.

What kind of change does this PR introduce?
Docs

Motivation

  • It was getting harder to reach the desired section in the doc.
  • CI failing while modifying dependency (not committing the package-lock.json)

Hence everything sorted 🎉

@webpack-bot

Copy link
Copy Markdown

Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon.

@misterdev misterdev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Well done, it's nice to have a TOC here! I've left some comments :)

Comment thread .github/CONTRIBUTING.md Outdated
Comment thread .github/CONTRIBUTING.md Outdated
Comment thread .github/CONTRIBUTING.md Outdated
Comment thread .github/CONTRIBUTING.md Outdated
Comment thread .github/CONTRIBUTING.md Outdated

@ematipico ematipico left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A small change

Comment thread .github/CONTRIBUTING.md Outdated
- [Your first Contribution](#your-first-contribution)
- [Setup](#setup)
- [Using npm](#using-npm)
- [Using yarn](#using-yarn)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The indentation is not correct. Could you please check with prettier? Or an online linter? https://dlaa.me/markdownlint/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done, pls join the discussion on #850

@ghost

ghost commented Apr 22, 2019

Copy link
Copy Markdown

There were the following issues with this Pull Request

  • Commit: 06b4929
    • ✖ message may not be empty
    • ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.


🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

@anshumanv anshumanv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bad rebase 😅

@webpack-bot

Copy link
Copy Markdown

@pranshuchittora Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@anshumanv Please review the new changes.

adds table of contents and adds some information about dependencies in the project
updates the table of contents based on review
fixes linting based on markdownlint
trying to resolve merge conflicts

@anshumanv anshumanv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@evenstensberg evenstensberg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ematipico for final thoughts regarding indents

@ematipico
ematipico merged commit 309cc1c into webpack:master Apr 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants