InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Docs for Trusted Committers

Open
#433 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:gear: Type - Meta
Dominant language
HTML
Stars
853
Forks
206
Avg merge
1d 23h
Merged PRs (30d)
2

Description

There are a couple of things about the way that we maintain this repo that we have not documented yet.
I think that most, if not all of them, are about how we host our patterns in gitbook.

We should document all of them, so that all Trusted Committers (TC) can work independently on this repo.

Things that need further documentation:

  • the gitbook setup (incl how to give access to gitbook for further TCs)
  • Google Analytics setup (incl how to give access to gitbook for further TCs)
  • DNS config for gitbook (dependency to others in the ISC)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the GitBook setup, Google Analytics access, and DNS configuration, including dependencies on others in the ISC. Done means Trusted Committers can use the documented procedures to maintain the repo independently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.