From be341e766aacaeadcd62c4b9388f989a88969cf4 Mon Sep 17 00:00:00 2001 From: Arbaaz Ahmed Date: Thu, 12 Feb 2026 10:49:05 +0530 Subject: [PATCH 1/2] docs: improve README navigation and contribution guidance --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f988da6..2409dd2 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ 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) ## 📌 Who Should Use This Repository? @@ -25,13 +30,13 @@ 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) ### Contribution Expectations @@ -43,7 +48,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 @@ -65,7 +70,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 @@ -106,10 +111,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 @@ -123,11 +128,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 | --- From 7b14f62ff5cdda95e71eedcc2f02485d4a5dd540 Mon Sep 17 00:00:00 2001 From: Arbaaz Ahmed Date: Thu, 12 Feb 2026 11:01:56 +0530 Subject: [PATCH 2/2] docs: add how to contribute section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2409dd2..7308fe4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ in AOSSIE projects or programs such as **Google Summer of Code (GSoC)**. - [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) ## 📌 Who Should Use This Repository? @@ -38,6 +39,18 @@ This section applies to **all contributors**, including **newcomers** and - **Copyright and licensing information** 👉 [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 - Follow respectful and inclusive communication