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

Improve README documentation and file structure #269

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Stazz0
Copy link

@Stazz0 Stazz0 commented Jul 23, 2024

Description
This pull request focuses on improving the readability and clarity of the documentation within the README.md file. The changes aim to enhance user understanding and ease of navigation.

Specific Changes:

  • Improved Language: Statements have been rephrased for better clarity and conciseness.
  • Referenced File Highlighting: The name of the referenced file (README.md) is now emphasized to improve focus and context.
  • Punctuation: Appropriate punctuation marks have been added to enhance sentence structure and overall readability.

@Stazz0
Copy link
Author

Stazz0 commented Jul 23, 2024

Hii @aswaterman
I've submitted this pull request to improve the README. Can you please review the changes and let me know if any adjustments are needed.

@IIITM-Jay
Copy link

IIITM-Jay commented Jul 23, 2024

Hi @Stazz0, as I can see that this PR contains the description, the same as what I have already did in the PR Documentation Improvement:: README.md dated 22nd July 2024(before this PR is being raised). The Description and the specific changes that you mentioned are following the same as I wrote in the above mentioned PR, better to avoid such kind of copying things in open source and it is not a good practice also.

It is always good to take reference from other PRs but not for copying the other's thought process. It should be generated from your end. And I am also seeing that you are continuously keep on making some sort of hanges that I have already done in PR 265, PR 266. You are making changes to the files which I have already made it.

@aswaterman, if you don't mind, could you please look into this matter, My already raised PRs in the chronological order are as follows, before this PR is being raised:

  1. PR 264 : Refactor and Optimization:: constants.py
  2. PR 265 : Documentation Improvement:: README.md
  3. PR 266 : Enhancement and Optimization:: Makefile
  4. PR 267 : Modified installation commands to workflows
  5. PR 268 : Refactor and Optimization:: Argument Table Formation:: Constants.py

@Stazz0
Copy link
Author

Stazz0 commented Jul 24, 2024

Hello @IIITM-Jay

Thank you for bringing this to my attention. I understand your concern about similarities between our PR descriptions.

However, I'd like to assure you that I independently made the changes you mentioned in my PR. I started working on improving the documentation around 18th July - five days before your PR was submitted on July 22nd. I have committed those changes on my riscv/riscv-opcode forked repo if you don't believe you can check my repo, I will also provide you a screenshot of it.
You should first look for the information before making any allegation on someone.

I believe it's a positive outcome that we're both focused on enhancing the project's documentation and build process.
Ultimately, our goal is to contribute positively to the RISC-V opcodes project. Let's focus on constructive collaboration and avoid accusations.

I understand you tagged the maintainer. If a conflict arises, I'm happy to discuss this further with the maintainer name to clarify the situation.

Screenshot from 2024-07-24 21-29-44

@IIITM-Jay
Copy link

Hi @Stazz0 , may be yes you were committing from 18 July, but the description you mentioned were nearly replica of what I wrote to describe my PRs. I am talking about that only and not the changes(the description is a matter of concern). Some of the words are also the same. Perhaps the changes are not same but the description you might have thought to write after my submission of PR, this can be pretty evident

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