Skip to content

docs: update contribution guidelines and website link in README#888

Open
strangerobot wants to merge 3 commits intotattle-made:mainfrom
strangerobot:feat/readme_change
Open

docs: update contribution guidelines and website link in README#888
strangerobot wants to merge 3 commits intotattle-made:mainfrom
strangerobot:feat/readme_change

Conversation

@strangerobot
Copy link
Copy Markdown
Contributor

@strangerobot strangerobot commented Apr 7, 2026


name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''


Describe the PR
Added an exclamantion to read.

Summary by CodeRabbit

  • Documentation
    • Minor README formatting: adjusted spacing and punctuation in the Contribution Pathways sentence and updated the Website reference line for clearer emphasis.
  • Chores
    • Added an ignore rule for macOS system files and tidied end-of-file whitespace.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1d42e523-608a-45b0-b9ee-36e5dcbbdc1f

📥 Commits

Reviewing files that changed from the base of the PR and between cf703ff and ac2e278.

⛔ Files ignored due to path filters (4)
  • uli-website/static/Track_Icons/Database.png is excluded by !**/*.png
  • uli-website/static/Track_Icons/Slur Editor.png is excluded by !**/*.png
  • uli-website/static/Track_Icons/Tools.png is excluded by !**/*.png
  • uli-website/static/Track_Icons/Workshops.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • .gitignore
✅ Files skipped from review due to trivial changes (1)
  • .gitignore

📝 Walkthrough

Walkthrough

Whitespace and punctuation edits: README.md had trailing whitespace added to a contribution sentence and the Website URL line changed from https://uli.tattle.co.in/ to https://uli.tattle.co.in/ !!!. .gitignore added an ignore pattern for macOS Finder files (**/.DS_Store) and a trailing blank line.

Changes

Cohort / File(s) Summary
Docs & Config
README.md, .gitignore
README.md: added trailing whitespace to a contribution sentence and appended " !!!" after the Website URL (https://uli.tattle.co.in/https://uli.tattle.co.in/ !!!). .gitignore: added **/.DS_Store ignore pattern and a trailing blank line.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through lines both mild and small,
A space, three cheers, I nudged them all,
A dotfile hid from curious eyes,
Now tidy paths and README sighs,
I nibble joy — a tiny change, that's all! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete and lacks detail. It contains only a single sentence with a spelling error and does not follow the template structure with required sections. Complete the PR description following the template: provide detailed explanation of changes, testing steps, expected behavior, and any additional context. Fix spelling errors and capitalize sentences properly.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: updating contribution guidelines and website link in README, which aligns with the actual modifications made to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

README.md Outdated
## Website

Visit the Uli website at https://uli.tattle.co.in/
Visit the Uli website at https://uli.tattle.co.in/ !
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

we prefer 3 exclamation marks.

@dennyabrain
Copy link
Copy Markdown
Contributor

Please capitalize the PR description

Copy link
Copy Markdown

@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: 1

🧹 Nitpick comments (1)
README.md (1)

32-32: Remove trailing whitespace on the contribution sentence.

Line 32 has a trailing space at the end, which can create an unintended Markdown line break (and lint noise).

Suggested cleanup
-We cherish diversity of experiences and perspectives. It adds value to our work. To this end, we strongly encourage candidates who find alignment with the project and are driven to learn, to contribute to Uli. There are both code and no-code issues that you can contribute to. 
+We cherish diversity of experiences and perspectives. It adds value to our work. To this end, we strongly encourage candidates who find alignment with the project and are driven to learn, to contribute to Uli. There are both code and no-code issues that you can contribute to.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 32, Remove the trailing whitespace at the end of the
contribution sentence "We cherish diversity of experiences and perspectives. It
adds value to our work. To this end, we strongly encourage candidates who find
alignment with the project and are driven to learn, to contribute to Uli. There
are both code and no-code issues that you can contribute to." (the sentence
shown in the diff) so the Markdown line does not include an unintended break or
lint noise; simply trim the trailing space character at the end of that line.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 116: Remove the extra space before the exclamation mark and replace the
raw URL with a Markdown link for cleaner rendering: update the line "Visit the
Uli website at https://uli.tattle.co.in/ !" to use a Markdown link like "Visit
the Uli website at [Uli](https://uli.tattle.co.in/)!" ensuring no extra space
before the final "!".

---

Nitpick comments:
In `@README.md`:
- Line 32: Remove the trailing whitespace at the end of the contribution
sentence "We cherish diversity of experiences and perspectives. It adds value to
our work. To this end, we strongly encourage candidates who find alignment with
the project and are driven to learn, to contribute to Uli. There are both code
and no-code issues that you can contribute to." (the sentence shown in the diff)
so the Markdown line does not include an unintended break or lint noise; simply
trim the trailing space character at the end of that line.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1fd5808d-9481-4473-ad42-18eab724b9fe

📥 Commits

Reviewing files that changed from the base of the PR and between 5a35861 and c8ae3f9.

📒 Files selected for processing (1)
  • README.md

README.md Outdated
## Website

Visit the Uli website at https://uli.tattle.co.in/
Visit the Uli website at https://uli.tattle.co.in/ !
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Tighten website line formatting for cleaner rendering.

Line 116 has an extra space before !; also, a Markdown link is clearer than a raw URL.

Proposed fix
-Visit the Uli website at https://uli.tattle.co.in/ !
+Visit the Uli website at [https://uli.tattle.co.in/](https://uli.tattle.co.in/)!
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Visit the Uli website at https://uli.tattle.co.in/ !
Visit the Uli website at [https://uli.tattle.co.in/](https://uli.tattle.co.in/)!
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 116, Remove the extra space before the exclamation mark
and replace the raw URL with a Markdown link for cleaner rendering: update the
line "Visit the Uli website at https://uli.tattle.co.in/ !" to use a Markdown
link like "Visit the Uli website at [Uli](https://uli.tattle.co.in/)!" ensuring
no extra space before the final "!".

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.

2 participants