Skip to content

Comments

fix(docs): view Holdex Principles#62

Merged
zolotokrylin merged 1 commit intomainfrom
61-problem-contributors-cant-access-dos-and-donts-guidelines
Nov 14, 2025
Merged

fix(docs): view Holdex Principles#62
zolotokrylin merged 1 commit intomainfrom
61-problem-contributors-cant-access-dos-and-donts-guidelines

Conversation

@zolotokrylin
Copy link
Member

@zolotokrylin zolotokrylin commented Nov 12, 2025

resolve: #61

Summary by CodeRabbit

  • Documentation
    • Updated contributor guidelines with revised reference materials.

Note: This release contains internal documentation updates for contributors. No end-user features or functionality have changed.

Signed-off-by: Vadim <vadim@holdex.io>
@zolotokrylin zolotokrylin self-assigned this Nov 12, 2025
@zolotokrylin zolotokrylin linked an issue Nov 12, 2025 that may be closed by this pull request
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Walkthrough

Updated .github/CONTRIBUTING.md to replace a broken "DOs and DON'Ts" reference with a new "Principles" reference, resolving the issue where contributors could not access team guidance documentation.

Changes

Cohort / File(s) Change Summary
Documentation reference update
\.github/CONTRIBUTING\.md
Replaced the DOs and DON'Ts document reference with a Principles reference to fix broken contributor guidance link

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Straightforward documentation link update with no code logic involved

Possibly related PRs

Suggested reviewers

  • markholdex
  • angelicawill

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title mentions fixing documentation related to 'Holdex Principles', but the change only updates a reference path from 'DOs and DON'Ts' to 'Principles' without addressing the core issue of broken access. Clarify whether the PR actually restores access to guidelines or merely renames a reference; verify that the linked document now exists and is accessible to contributors.
Linked Issues check ❓ Inconclusive The PR changes a documentation reference but doesn't clearly demonstrate that the broken link is fixed or that guidelines are now accessible to contributors as required by issue #61. Confirm that the new 'Principles' reference points to an existing, accessible document and that contributors can now view the guidelines without encountering broken links.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Out of Scope Changes check ✅ Passed The PR only modifies .github/CONTRIBUTING.md with a documentation reference update, which is directly related to resolving issue #61 about accessing guidelines.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 61-problem-contributors-cant-access-dos-and-donts-guidelines

📜 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 31470a3 and 30cdd7e.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md (1 hunks)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

7-7: PRINCIPLES.md is correctly positioned and the link resolves properly.

The verification confirms that .github/PRINCIPLES.md exists and is accessible, with appropriate content ("Our Principles" and "The 6 Rules We Live By"). The relative path ./PRINCIPLES.md from .github/CONTRIBUTING.md resolves correctly. The change successfully fixes the broken link issue.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@holdex
Copy link

holdex bot commented Nov 12, 2025

Bug Report Checklist

Status Commit Link Bug Author
✅ Submitted commit link @zolotokrylin

@holdex
Copy link

holdex bot commented Nov 12, 2025

Time Submission Status

Member Status Time Action Last Update
zolotokrylin ✅ Submitted 11min Update time Nov 14, 2025, 12:26 AM
dante4rt ✅ Submitted 5min Update time Nov 12, 2025, 7:59 AM

Copy link
Contributor

@dante4rt dante4rt left a comment

Choose a reason for hiding this comment

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

lgtm

@zolotokrylin
Copy link
Member Author

@pr-time-tracker bug commit 31470a3 && bug author @zolotokrylin

@zolotokrylin zolotokrylin merged commit e452a0a into main Nov 14, 2025
4 checks passed
@zolotokrylin zolotokrylin deleted the 61-problem-contributors-cant-access-dos-and-donts-guidelines branch November 14, 2025 00: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.

Bug: contributors can't access DOs and DON'Ts guidelines

2 participants