Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 5.13 KB

CONTRIBUTING.md

File metadata and controls

79 lines (46 loc) · 5.13 KB
Raw

Contributing

Thanks for your interest in contributing to the Stencil Docs! 🎉

Creating an Issue

  • If you have a question about using Stencil, please ask in the Stencil Worldwide Slack group.

  • It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.

  • The issue list of this repository is exclusively for bug reports, docs issues and feature requests. Non-conforming issues will be closed immediately.

  • Issues with no clear steps to reproduce will not be triaged. If an issue is labeled with "needs reply" and receives no further replies from the author of the issue for more than 5 days, it will be closed.

  • If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported. You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.

  • Next, create a new issue that thoroughly explains the problem.

Creating a Pull Request

  • We appreciate you taking the time to contribute! Before submitting a pull request, we ask that you please create an issue that explains the bug, docs issue, or feature request and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. This helps us to keep track of the pull request and make sure there isn't duplicated effort.

  • Looking for an issue to fix? Make sure to look through our issues with the help wanted label!

Setup

  1. Fork the repo.
  2. Clone your fork.
  3. Make a branch for your change.
  4. Run npm install (make sure you have node and npm installed first).

Developing

  1. Run npm run dev

Adding Documentation

  1. To add documentation first create a new markdown file in docs-md in the folder that fits your doc best. For example, if your doc is covering something in the Stencil compiler, you would put it in docs-md/compiler.
  2. Write your documentation following the style in the other docs markdown files. Try to aim for being as clear and concise as possible. We recommend checking out the vue.js docs for examples of good docs.
  3. Open src/components/stencil-site.tsx in your editor and add the path to your new docs markdown file but using .html instead of .md to here. For example, if my new doc was located at docs-md/basics/my-cool-doc.md I would add 'my-cool-doc': 'basics/my-cool-doc.html', to that object.
  4. Open src/components/site-menu.tsx in your editor and add a new <stencil-route-link /> with the url attribute pointing to the path for your new doc. For example, if I just added the doc mentioned above, my path would be basics/my-cool-doc.
  5. Run npm run dev to make sure your doc shows up in the menu, that you can navigate to the doc, and that your docs layout looks correct.

Modifying documentation

  1. Locate the doc you want to modify in docs-md/.
  2. Modify the documentation, making sure to keep the format the same as the rest of the doc.
  3. Run npm run dev to make sure your changes look correct.

Commit Message Format

We have very precise rules over how our git commit messages should be formatted. This leads to readable messages that are easy to follow when looking through the project history.

type(scope): subject

Type

Should be docs

Scope

The scope can be anything specifying the place of the commit change. For example router, prerendering, etc. If you make multiple commits for the same doc, please keep the naming of this doc consistent. For example, if you make a change to the router docs and the first commit is docs(router), you should continue to use router for any more commits related to navigation.

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • do not capitalize first letter
  • do not place a period . at the end
  • entire length of the commit message must not go over 50 characters
  • describe what the commit does, not what issue it relates to or fixes
  • be brief, yet descriptive - we should have a good understanding of what the commit does by reading the subject

License

By contributing your code to the ionic-team/stencil-site GitHub Repository, you agree to license your contribution under the MIT license.