getsentry / getsentry/sentry-ruby
Improve README.md and CONTRIBUTING.md
- 主要言語
- Ruby
- スター
- 987
- フォーク
- 541
- 平均マージ
- 17時間 40分
- マージ済み PR(30日)
- 19
説明
For better experience for new contributors we should improve our "how to get started" documentation inside the repository. (Basically the files `README.md` and `CONTRIBUTING.md`.)
Cool would be that a new developer can find all the information she needs on how to set up her local environment, run tests and start to contribute.
It has been done already for [sentry-python](https://github.com/getsentry/sentry-python) so we can steal a lot of stuff from over there.
This is how those files should look like (If the section is not applicable to the SDK, we can ommit it.)
### README.md
- Sentry header (if not already there copy from sentry-python)
- badges of coverage etc for different versions/integrations (if available)]
- Headline1: Getting started
- Headline2: Requirements (describe if there are any requirements that need to met in order for the SDK to work.)
- Headline2: Install (how to install the SDK to the local dev environment)
- Headline2: Configuration (how to add the SDK to your project)
- Headline2: Usage (how to verify configuration, enriching stuff and so on.)
- Headline1: Integrations (list of all integrations (if any) with links to documentation)
- Headline1: Migrate from {old version name} (if there is a old raven version or some other incompatible old version)
- Headline1: Contributing to the SDK (link to [CONTRIBUTING.md](http://contributing.md/))
- Headline1: Getting Help/Support (describing how to get help/support. just copy text from sentry-python repository)
- Headline1: Resources (links to places on the web)
- Headline1: License (link to license file. see sentry-python repository)
(as a template on how this should look like see: [https://github.com/getsentry/sentry-python/blob/master/README.md](https://github.com/getsentry/sentry-python/blob/master/README.md))
### CONTRIBUTING.md
- intro text and link to how to contribute to documentation (copy from sentry-python repository)
- Headline1: How to report a problem (copy from sentry-python repository)
- Headline1: Submitting changes (copy from sentry-python repository)
- Headline1: Development Environment (how to set up, step by step guide. should be as easy as possible so that novice devs can do it. should work when copy pasting into shell on a fresh computer)
- Headline1: Running Tests (step by step guide. should work when copy pasting into shell on a fresh computer)
- Headline1: Releasing a new Version (copy from and ammend from sentry-python if this SDK also uses craft for deployment)
- Headline2: Versioning Policy (copy from sentry-python, if this SDK also uses semver)
- Headline1: Commit message guideline (link to docs, copy from sentry-python)
(as a template on how this should look like see: [https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md))
コントリビューションガイド
調査の方向性
README.md と CONTRIBUTING.md から始め、その後、issue にリンクされている sentry-python のテンプレートと両方を比較します。リポジトリの実際の要件、ローカルセットアップ、テストワークフロー、コントリビューションプロセス、サポートリソース、リリースに関するガイダンス、ライセンスの詳細を確認してから文書化してください。新しいコントリビューターがファイルに従ってセットアップとテストを行い、コントリビューションを始められる状態になれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- ruby
- 領域
- developer-experience, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100