1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
lens/docs/contributing/documentation.md
Roman ff6d3492de Rebasing branch before pushing to remote
PageRegistration / PageMenuRegistration fixes & more simplification (#1386)

* PageRegistration & PageMenuRegistration fixes & more simplification, fix #1383

Signed-off-by: Roman <ixrock@gmail.com>

* clean up test, deprecate page.routePath

Signed-off-by: Roman <ixrock@gmail.com>

* fix: proper `isActive` state matching for page-menu-target to page considering current document location

Signed-off-by: Roman <ixrock@gmail.com>

set "allowJs" to false in tsconfig (#1377)

- None of the .ts files include any of the .js files

- All .js files are either passed to electron-builder or used as config
  files for other programs.

Signed-off-by: Sebastian Malton <sebastian@malton.name>

cleanup main side of metrics route for readability (#988)

* cleanup main side of metrics route for readability

* split out ??= for headers

Signed-off-by: Sebastian Malton <sebastian@malton.name>

Release v4.0.0-beta.3 (#1395)

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

Removed Advanced Topics bullet from Extension Development > Overview. Reworked content in Extension Development > Extension Capabilities, Extension Development > Testing and Publishing, and Contributing sections. Improved consistency throughout docs.

Signed-off-by: Paul Williams <pawilliams@mirantis.com>
2020-11-16 16:15:55 -08:00

1.7 KiB

Documentation

We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source.

Finding Documentation Issues to Work On

You can find a list of open documentation-related issues here. When you find something you would like to work on:

  1. Express your interest to start working on an issue via comments.
  2. One of the maintainers will assign the issue for you.
  3. You can start working on the issue. When you're done, simply submit a pull request.

Requirements for Documentation Pull Requests

When you create a new pull request, we expect some requirements to be met.

  • Follow this naming convention for Pull Requests:
    • When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started
    • When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started
    • When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started
  • If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close.
  • For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.