Skip to content

Comments

docs: do this and don't do that#56

Merged
zolotokrylin merged 6 commits intomainfrom
zolotokrylin-patch-2
Apr 16, 2025
Merged

docs: do this and don't do that#56
zolotokrylin merged 6 commits intomainfrom
zolotokrylin-patch-2

Conversation

@zolotokrylin
Copy link
Member

@zolotokrylin zolotokrylin commented Apr 16, 2025

Resolves: https://github.com/holdex/marketing/issues/48

Summary by CodeRabbit

  • Documentation
    • Added a new team guidelines document outlining key behaviors to adopt and avoid for improved collaboration and productivity.
    • Updated contributing guidelines to reference the new team guidelines document.
    • Enhanced the README with a link to the team guidelines and a note encouraging subscription to repository notifications for updates.

Signed-off-by: Vadim <vadim@holdex.io>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 16, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new documentation file, .github/DONTS.md, has been introduced. This file details team principles and guidelines for working at Holdex, including core values, behavioral expectations, remote work hours, required collaboration tools, and references to additional guides on marketing content and compensation policies. The .github/CONTRIBUTING.md was updated to replace "respectable" with "respectful" in the Code of Conduct section and to advise permanent contributors to read the new "DOs and DON'Ts" document. The README.md was updated to include a link to the "DOs & DON'T" document and an advisory note encouraging developers to subscribe to repository notifications. No changes were made to code or exported entities.

Changes

File(s) Change Summary
.github/DONTS.md Added a markdown file outlining team principles, behavioral guidelines, remote work hours, required tools, and links to further documentation.
.github/CONTRIBUTING.md Changed "respectable" to "respectful" in Code of Conduct; added reference to .github/DONTS.md for permanent contributors.
README.md Added link to "DOs & DON'T" document and advisory note encouraging subscription to repository notifications.

Sequence Diagram(s)

No sequence diagram is generated, as the change is solely the addition and modification of documentation files without impact on code or control flow.

Assessment against linked issues

Objective Addressed Explanation
Move Leave Policy and Principles content to Guidelines and remove from marketing website (#48) This PR adds new team guidelines but does not relocate or remove Leave Policy or Principles content.

Possibly related PRs

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90e8c6e and 63e1e70.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md (1 hunks)
  • .github/DONTS.md (1 hunks)
  • README.md (1 hunks)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
.github/DONTS.md (4)

11-15: Vary sentence structure for improved readability.

Several sentences in the "Our Principles" section begin with "We." Consider rephrasing some sentences to avoid repetition and enhance readability. For example:

  • "We align with the goals and execute them." → "Goal alignment and execution are central to our approach."
  • "We act as leaders and co-own the product." → "Acting as leaders, we co-own the product and define our own backlog."
  • "We are agile and deliver new increments daily." → "Agility is key; we deliver new increments daily."
  • "We value our time." → "Time is valued highly within our team."
  • "We wear many hats." → "Team members wear many hats, coding, designing, testing, and more."
  • "We figure things out ourselves." → "Self-learning is encouraged, whether through documentation, tutorials, or peer support."

This will make the document more engaging and professional.

🧰 Tools
🪛 LanguageTool

[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...esponsibility for solving the problems. We are agile and deliver new increments da...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...agile and deliver new increments daily. We decompose big problems into smaller one...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...complete them in not more than 4 hours. We value our time. We have only one meetin...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t more than 4 hours. We value our time. We have only one meeting with the team per...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g with the team per week - that simple. We all work autonomously, communicate asyn...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k things on Fridays because we love it. We’re here to build great products with li...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...great products with like-minded people. We figure things out ourselves. We learn t...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...people. We figure things out ourselves. We learn terminology, read documentation, ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


3-3: Replace hard tab with spaces for markdown consistency.

Line 3 contains a hard tab character. Replace it with spaces to maintain consistent formatting in markdown files.

-Our Principles	
+Our Principles
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

3-3: Hard tabs
Column: 15

(MD010, no-hard-tabs)


30-30: Insert a comma before "so" for grammatical correctness.

Add a comma before "so" in "leave updates where you left off so others can pick it up" to properly connect the clauses.

-Before switching off, leave updates where you left off so others can pick it up.
+Before switching off, leave updates where you left off, so others can pick it up.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~30-~30: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ng off, leave updates where you left off so others can pick it up. Blackout and exp...

(COMMA_COMPOUND_SENTENCE_2)


62-62: Add a space after the hash for proper markdown heading formatting.

Line 62 is missing a space after the hash in the markdown heading. Add a space to ensure correct rendering.

-#principles #holdex
+# principles #holdex
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

62-62: No space after hash on atx style heading
null

(MD018, no-missing-space-atx)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 77f645f and 90e8c6e.

📒 Files selected for processing (1)
  • .github/DONTS.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/DONTS.md

[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...esponsibility for solving the problems. We are agile and deliver new increments da...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...agile and deliver new increments daily. We decompose big problems into smaller one...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...complete them in not more than 4 hours. We value our time. We have only one meetin...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t more than 4 hours. We value our time. We have only one meeting with the team per...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g with the team per week - that simple. We all work autonomously, communicate asyn...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k things on Fridays because we love it. We’re here to build great products with li...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...great products with like-minded people. We figure things out ourselves. We learn t...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...people. We figure things out ourselves. We learn terminology, read documentation, ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~30-~30: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ng off, leave updates where you left off so others can pick it up. Blackout and exp...

(COMMA_COMPOUND_SENTENCE_2)

🪛 markdownlint-cli2 (0.17.2)
.github/DONTS.md

3-3: Hard tabs
Column: 15

(MD010, no-hard-tabs)


62-62: No space after hash on atx style heading
null

(MD018, no-missing-space-atx)

🔇 Additional comments (1)
.github/DONTS.md (1)

1-65: Content and structure are clear and valuable.

The document is well-organized and provides clear guidance for team members. These principles and guidelines will help foster a productive and aligned team culture.

🧰 Tools
🪛 LanguageTool

[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...esponsibility for solving the problems. We are agile and deliver new increments da...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...agile and deliver new increments daily. We decompose big problems into smaller one...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...complete them in not more than 4 hours. We value our time. We have only one meetin...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t more than 4 hours. We value our time. We have only one meeting with the team per...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g with the team per week - that simple. We all work autonomously, communicate asyn...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k things on Fridays because we love it. We’re here to build great products with li...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...great products with like-minded people. We figure things out ourselves. We learn t...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...people. We figure things out ourselves. We learn terminology, read documentation, ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~30-~30: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ng off, leave updates where you left off so others can pick it up. Blackout and exp...

(COMMA_COMPOUND_SENTENCE_2)

🪛 markdownlint-cli2 (0.17.2)

3-3: Hard tabs
Column: 15

(MD010, no-hard-tabs)


62-62: No space after hash on atx style heading
null

(MD018, no-missing-space-atx)

@holdex
Copy link

holdex bot commented Apr 16, 2025

@zolotokrylin
⚠️⚠️⚠️
You must submit the time spent on this PR.
⚠️⚠️⚠️

Signed-off-by: Vadim <vadim@holdex.io>
Signed-off-by: Vadim <vadim@holdex.io>
Signed-off-by: Vadim <vadim@holdex.io>
Signed-off-by: Vadim <vadim@holdex.io>
@zolotokrylin zolotokrylin changed the title [DRAFT] docs: do this and don't do that docs: do this and don't do that Apr 16, 2025
Signed-off-by: Vadim <vadim@holdex.io>
@zolotokrylin zolotokrylin merged commit a6f4139 into main Apr 16, 2025
@zolotokrylin zolotokrylin deleted the zolotokrylin-patch-2 branch April 16, 2025 03:26
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.

1 participant