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 #66

Closed
wants to merge 1 commit into from
Closed

Conversation

GUNJESH843
Copy link

To enhance the TwinTrim documentation, consider incorporating the following table of contents:

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. Contributing
  6. License

Here’s the formatted template to use for your GitHub pull request:


Description

Added a table of contents to the documentation to improve navigation. This change enhances the usability of the documentation by allowing users to quickly locate sections.

Type of change

Please delete options that are not relevant:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Tests 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

added a table of contents
@Kota-Karthik
Copy link
Owner

@GUNJESH843
I think we already have a README.MD , but its an really good idea to add a Index page
but could you just add index page within the README.MD

@GUNJESH843
Copy link
Author

@Kota-Karthik This PR is for the same I have edited and added a table of contents within the readme.md file itself

Please look into it and I have not received any Gssoc badge I am Gssoc contributor

Regards,
@GUNJESH843

@Kota-Karthik
Copy link
Owner

@GUNJESH843
We already have a CONTRIBUTION.MD file , it has a typo a CONSTRIBUTION.MD
please hyperlink it in the Contributing section and also fix the typo of CONSTRIBUTION.MD to CONTRIBUTION.MD

@Kota-Karthik
Copy link
Owner

@GUNJESH843
Are you working on it?

@GUNJESH843
Copy link
Author

GUNJESH843 commented Oct 5, 2024

@Kota-Karthik
yes I have worked on it and created a pr #79 review it once

@techy4shri techy4shri closed this Oct 6, 2024
@GUNJESH843 GUNJESH843 deleted the patch-1 branch October 6, 2024 15:56
@GUNJESH843
Copy link
Author

@Kota-Karthik @techy4shri, I believe there’s been some misunderstanding. Before jumping to conclusions, it would be helpful to consider the context.

@Kota-Karthik specifically asked me to fix the typo (as referenced here: #66 (comment)). I made the necessary changes as requested, but now the PR has been closed, and I'm being told that file name changes are not allowed.

Could you please clarify why I was asked to make these changes if the file name adjustment wasn’t acceptable?
Also, why was this PR closed without any comments explaining the decision?

Thanks for your time; I hope you respect mine as well.

@techy4shri
Copy link
Collaborator

You do not raise a PR specifically for file change, like you did in the other one. We cannot accept that as part of the program.
Also, readme contributions are highly discouraged, as you haad been assigned, I will wait for the review from @Kota-Karthik
but I see you have deleted the branch.

@techy4shri
Copy link
Collaborator

I checked with the PA and no, ther has been no misunderstanding and I can tell you with certaininty that I am not jumping to conclusions here. Yes, I can see that he asked you to fix the typo but rather than raisign a new PR, you could have simply made another commit in this one. So this PR will remian closed now.

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.

[Documentation Request: Add Index Page]
3 participants