Skip to content

docs: improve README navigation and contribution guidance #43

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.

Sign up for GitHub

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

Open
Arbaaz123676 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: improve README navigation and contribution guidance #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be341e7
docs: improve README navigation and contribution guidance
Arbaaz123676 Feb 12, 2026
7b14f62
docs: add how to contribute section
Arbaaz123676 Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ All members are expected to read the relevant sections **before participating**
in AOSSIE projects or programs such as **Google Summer of Code (GSoC)**.

---
## 📚 Table of Contents

- [Who Should Use This Repository?](#who-should-use-this-repository)
- [Guidance for Contributors](#guidance-for-contributors)
- [Required Reading (Before Contributing)](#required-reading-before-contributing)
- [How to Contribute](#how-to-contribute)

Comment on lines 10 to 16
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 12, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Confirm TOC link fragments resolve correctly.

markdownlint flagged invalid fragments for the new TOC entries, which can happen when headings include emojis or punctuation. Please verify the generated anchor IDs match the links (GitHub vs. other renderers) and adjust if needed to avoid broken navigation.

🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 12-12: Link fragments should be valid

(MD051, link-fragments)

[warning] 13-13: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents 
In `@README.md` around lines 10 - 15, The Table of Contents links currently point
to header fragments that may not match GitHub's anchor generation; update either
the link fragments or the corresponding headings so they match GitHub-style
anchors (lowercase, spaces → hyphens, remove punctuation and emojis).
Specifically verify and fix the TOC entries for "Who Should Use This
Repository?", "Guidance for Contributors", and "Required Reading (Before
Contributing)" so their fragments become e.g. `#who-should-use-this-repository`,
`#guidance-for-contributors`, and `#required-reading-before-contributing`, or
alternatively remove/adjust punctuation or emojis from the headings to make the
generated anchors match the existing links.

## 📌 Who Should Use This Repository?

Expand All @@ -25,13 +31,25 @@ This section applies to **all contributors**, including **newcomers** and
### Required Reading (Before Contributing)

- **Communication rules and community behavior**
👉 [Communication Guidelines and Rules](https://github.com/AOSSIE-Org/Info/blob/main/CommunicationGuidelinesAndRules.md)
👉 [Communication Guidelines and Rules](CommunicationGuidelinesAndRules.md)

- **Social media usage and representation guidelines**
👉 [Social Media Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/SocialMediaGuidelines.md)
👉 [Social Media Guidelines](SocialMediaGuidelines.md)

- **Copyright and licensing information**
👉 [Copyright Information](https://github.com/AOSSIE-Org/Info/blob/main/COPYRIGHT.md)
👉 [Copyright Information](COPYRIGHT.md)

---

## 🤝 How to Contribute

1. Fork this repository
2. Create a new branch
3. Make documentation improvements
4. Commit with clear messages
5. Open a Pull Request

Please keep formatting consistent with existing documents.

### Contribution Expectations

Expand All @@ -43,7 +61,7 @@ This section applies to **all contributors**, including **newcomers** and
### For GSoC Contributors

- **Mandatory reading before applying**
👉 [Google Summer of Code Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/GoogleSummerOfCode.md)
👉 [Google Summer of Code Guidelines](GoogleSummerOfCode.md)

- Make meaningful contributions **before** proposal submission
- Interact with mentors publicly via GitHub or Discord
Expand All @@ -65,7 +83,7 @@ This section applies to **project mentors and co-mentors**.
### GSoC Mentors

- Follow all policies defined in
👉 [Google Summer of Code Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/GoogleSummerOfCode.md)
👉 [Google Summer of Code Guidelines](GoogleSummerOfCode.md)

- Avoid conflicts of interest
- Provide regular evaluations and progress reviews
Expand Down Expand Up @@ -106,10 +124,10 @@ Ambassadors represent AOSSIE in public forums and platforms.
### Required Reading

- **Ambassador roles and responsibilities**
👉 [Ambassadors Program Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/Ambassadors.md)
👉 [Ambassadors Program Guidelines](Ambassadors.md)

- **Social media policies**
👉 [Social Media Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/SocialMediaGuidelines.md)
👉 [Social Media Guidelines](SocialMediaGuidelines.md)

### Expectations

Expand All @@ -123,11 +141,11 @@ Ambassadors represent AOSSIE in public forums and platforms.

| Document | Description |
|--------|-------------|
| [Communication Guidelines and Rules](https://github.com/AOSSIE-Org/Info/blob/main/CommunicationGuidelinesAndRules.md) | Community rules and communication standards |
| [Google Summer of Code Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/GoogleSummerOfCode.md) | GSoC-specific policies and expectations |
| [Social Media Guidelines](https://github.com/AOSSIE-Org/Info/blob/main/SocialMediaGuidelines.md) | Rules for social media usage |
| [Ambassadors Program](https://github.com/AOSSIE-Org/Info/blob/main/Ambassadors.md) | Ambassador roles and responsibilities |
| [Copyright Information](https://github.com/AOSSIE-Org/Info/blob/main/COPYRIGHT.md) | Copyright and ownership details |
| [Communication Guidelines and Rules](CommunicationGuidelinesAndRules.md) | Community rules and communication standards |
| [Google Summer of Code Guidelines](GoogleSummerOfCode.md) | GSoC-specific policies and expectations |
| [Social Media Guidelines](SocialMediaGuidelines.md) | Rules for social media usage |
| [Ambassadors Program](Ambassadors.md) | Ambassador roles and responsibilities |
| [Copyright Information](COPYRIGHT.md) | Copyright and ownership details |

---

Expand Down