search

mincho-js / mincho

Natural CSS in TypeScript
MIT License
40 stars 0 forks source link

Documentation for README, Contributting, GitHub Form #39

Closed black7375 closed 3 months ago

black7375 commented 3 months ago

Description

I've done the documentation we think is necessary first.

Related Issue

37

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update introduces several new files and templates to enhance project management and community engagement. Notable additions include funding options, structured issue templates for bugs and features, a code of conduct, and a comprehensive contributing guide. The README.md has been significantly expanded to articulate clearer project goals and motivations. These changes aim to improve documentation, facilitate contributions, and foster a supportive community environment.

Changes

File Path Change Summary
.github/FUNDING.yml Added funding options for multiple platforms including GitHub Sponsors and Ko-fi.
.github/ISSUE_TEMPLATE/*.yml Introduced structured issue templates for bug reports, feature requests, and meta issues, enhancing the reporting process.
.github/ISSUE_TEMPLATE/config.yml Enabled blank issues and defined contact links for feature requests.
.github/pull_request_template.md Created a structured template for pull requests to improve clarity in contributions.
CODE_OF_CONDUCT.md Established a code of conduct to promote a respectful and inclusive community environment.
CONTRIBUTING.md Laid out guidelines for contributing, including project setup and best practices.
README.md Expanded content to detail project vision, features, and contribution guidelines.
packages/css-additional-types/README.md Added a README to describe the purpose of the @mincho/css-additional-types package.
packages/debug-log/README.md Updated formatting and structure of the README for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Project

    User->>GitHub: Submit Issue
    GitHub->>Project: Route to Issue Template
    Project->>User: Display Suggested Template
    User->>Project: Fill Out Template
    Project->>GitHub: Send Completed Issue
    GitHub->>User: Confirmation of Issue

🐇✨ In the meadow, changes bloom and grow,
Templates and funding, helping us flow.
A code of conduct, fair and bright,
Together we gather, in joy and delight!
So hop along, dear friends, let’s play,
In this vibrant garden, we’ll thrive today! 🥕🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 3 months ago

Triggered from https://github.com/mincho-js/mincho/pull/39 by @​black7375.

Checking if we can fast forward main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (3a0775560b6dd8e57760dfa9e0468083ead9f09d).

Target branch (main):

commit 50fdebad5bbb13bb2a2ebe48edbac848d4454164 (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Fri Jul 19 17:07:06 2024 +0900

    Clean: Config formatting #35

Pull request (documentation):

commit 3a0775560b6dd8e57760dfa9e0468083ead9f09d (pull_request/documentation)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 13:50:57 2024 +0900

    Docs: Attach assets (logo, debug video) #37

It is possible to fast forward main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (3a0775560b6dd8e57760dfa9e0468083ead9f09d). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to documentation.

github-actions[bot] commented 3 months ago

Triggered from https://github.com/mincho-js/mincho/pull/39 by @​black7375.

Checking if we can fast forward main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a).

Target branch (main):

commit 50fdebad5bbb13bb2a2ebe48edbac848d4454164 (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Fri Jul 19 17:07:06 2024 +0900

    Clean: Config formatting #35

Pull request (documentation):

commit 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a (pull_request/documentation)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 14:24:27 2024 +0900

    Docs: Apply suggestions from code review #39

It is possible to fast forward main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to documentation.

black7375 commented 3 months ago

@coderabbitai resolve

coderabbitai[bot] commented 3 months ago
Actions performed Comments resolved.
black7375 commented 3 months ago

/fast-forward

github-actions[bot] commented 3 months ago

Triggered from https://github.com/mincho-js/mincho/pull/39#issuecomment-2241484586 by @​black7375.

Trying to fast forward main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a).

Target branch (main):

commit 50fdebad5bbb13bb2a2ebe48edbac848d4454164 (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Fri Jul 19 17:07:06 2024 +0900

    Clean: Config formatting #35

Pull request (documentation):

commit 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a (pull_request/documentation)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 14:24:27 2024 +0900

    Docs: Apply suggestions from code review #39

Fast forwarding main (50fdebad5bbb13bb2a2ebe48edbac848d4454164) to documentation (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a).

$ git push origin 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a:main
To https://github.com/mincho-js/mincho.git
   50fdeba..47e2bf3  47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a -> main