search

TheShiveshNetwork / readmekraft

Craft Perfect GitHub Markdown Files with AI
https://readmekraft.vercel.app
GNU General Public License v2.0
21 stars 5 forks source link

ADD CONTRIBUTING_GUIDELINES FILE TO READMEKRAFT #3

Closed Code-Hacker26 closed 2 months ago

Code-Hacker26 commented 2 months ago

Here by a fair attempt is made to add a contribution file dictating the process and guidelines for any contribution in the given repo "READMEKRAFT".

vercel[bot] commented 2 months ago

@Code-Hacker26 is attempting to deploy a commit to the theshiveshnetwork's projects Team on Vercel.

A member of the Team first needs to authorize it.

TheShiveshNetwork commented 2 months ago

Hey @Code-Hacker26 I have added some comments. Resolve them. It looks good, also I'll have one request. Can you make a standard README too? Use our tool for creating Project Readme Also link the CONTRIBUTING_GUIDELINES.md file here.

Code-Hacker26 commented 2 months ago

@TheShiveshNetwork , does Contributing.md need any change or is it good ?

And sure I can look into making README.md file for the same project

TheShiveshNetwork commented 2 months ago

@TheShiveshNetwork , does Contributing.md need any change or is it good ?

And sure I can look into making README.md file for the same project

I have added a few comments above. Resolve them first, then it will be good to go.

Code-Hacker26 commented 2 months ago

Hey @TheShiveshNetwork,

As a newcomer to open source, I'm still learning the ropes. I am unable to find your comments regarding the changes needed in the CONTRIBUTING.md file. It would be really helpful if we could discuss the details here.

TheShiveshNetwork commented 2 months ago

Hey @TheShiveshNetwork,

As a newcomer to open source, I'm still learning the ropes. I am unable to find your comments regarding the changes needed in the CONTRIBUTING.md file. It would be really helpful if we could discuss the details here.

I'll explain it here. There are two updates.

  1. [Line 17] The first step should be to fork the repository then all the steps. Shift the order of these to add this.
  2. [Line 71] Also, add the link to the LICENSE file
TheShiveshNetwork commented 2 months ago

@Code-Hacker26 alsk to see my added comments, go to the files changed section and there you'll see them on the mentioned lines in the above reply like line 17 and 71. Resolve them. And also add the README file in this pull request as mentioned. Then it can be merged.

TheShiveshNetwork commented 2 months ago

No worries @Code-Hacker26 since we require the guidelines ASAP, I'll take it up from here. Good Work. You take up to create README work. I'll create an issue. First comment there that you are interested then you can start working.