Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add several docs #23

Merged
merged 11 commits into from
Jul 16, 2024
Merged

Add several docs #23

merged 11 commits into from
Jul 16, 2024

Conversation

TonyCTHsu
Copy link
Contributor

@TonyCTHsu TonyCTHsu commented May 30, 2024

What

  1. Code of Conduct
  2. Security policy
  3. Contribution guide
  4. Github templates

Additionally,

  1. Udate gemspec homepage with github url
  2. Add shields in README.md

@TonyCTHsu TonyCTHsu requested a review from lloeki as a code owner May 30, 2024 10:03
docs/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
@TonyCTHsu TonyCTHsu requested a review from a team as a code owner July 8, 2024 12:34
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 3 to 4
![Gem Version](https://img.shields.io/gem/v/graft?style=for-the-badge&logo=rubygems)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Datadog/graft-rb/test.yml?style=for-the-badge&logo=github)
Copy link
Member

Choose a reason for hiding this comment

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

I really don't find those useful, and in fact misleading:

  • last version is on the right side (or it should be once we have release pages in GitHub, which we should), plus it doesn't reflect the actual commit shown
  • test result is not the one for the current commit

Copy link
Contributor Author

@TonyCTHsu TonyCTHsu Jul 16, 2024

Choose a reason for hiding this comment

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

last version is on the right side (or it should be once we have release pages in GitHub, which we should), plus it doesn't reflect the actual commit shown

It shown the last version released on Rubygems.org. I don't mind if we have release pages in GitHub.

test result is not the one for the current commit

I can add branch as parameters.

docs/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
graft.gemspec Show resolved Hide resolved
docs/CONTRIBUTING.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@TonyCTHsu TonyCTHsu merged commit b37c5d1 into main Jul 16, 2024
17 checks passed
@TonyCTHsu TonyCTHsu deleted the tonycthsu-docs branch July 16, 2024 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants