Skip to content
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.

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

Update README.md by adding Table of Contents #102

Closed
wants to merge 1 commit into from

Conversation

Maryam0330
Copy link
Contributor

@Maryam0330 Maryam0330 commented Oct 8, 2024

Description

This change updates the README.md file to now include a hyperlink based navigation which makes easier to access different sections of the long README file

  • It doesn't exactly fix an existing issue but it will help make the documentation better

Type of change

Please delete options that are not relevant.

  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes
  • I have maintained a clean commit history by using the necessary Git commands
  • I have checked that my code does not cause any merge conflicts

Screenshots (if applicable)

Add screenshots to help explain the changes (if necessary).

@Kota-Karthik
Copy link
Owner

@Maryam0330
Please follow the PR template we provided
add issue number

@Maryam0330
Copy link
Contributor Author

Done! 👍

@Wahid7852
Copy link
Collaborator

@Maryam0330 What is your Issue Number?

@Maryam0330
Copy link
Contributor Author

It doesn't solve a pre-existing issue, it's just a simple documentation update for better navigation. Do you want me to raise an issue first?

@techy4shri
Copy link
Collaborator

@Maryam0330 you need to go through the follwoing texts before making any PR:

  1. Readme.md (super helpful in knowing the basics)
  2. Contributing.md (THAT'S IMPORTANT DO NOT SKIP)

You do not raise a PR without raising an issue first and this repository does not accept readme contributions. Your PR is being rejected due to being invalid.

@techy4shri techy4shri closed this Oct 10, 2024
@techy4shri techy4shri added invalid This doesn't seem right wontfix This will not be worked on REJECTED Pull request rejected labels Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right REJECTED Pull request rejected wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants