Skip to content
This repository has been archived by the owner on Jan 9, 2023. It is now read-only.

[Docs]: Write a contributing guide #2

Closed
1 task done
gptkrsh opened this issue Dec 14, 2021 · 13 comments
Closed
1 task done

[Docs]: Write a contributing guide #2

gptkrsh opened this issue Dec 14, 2021 · 13 comments
Assignees
@Abhirv08
Labels
📄 aspect: text Concerns the textual material in the repository ⭐ goal: addition Addition of new feature good first issue New-contributor friendly 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for dev Ready for work

Comments

@gptkrsh
Copy link
Member

gptkrsh commented Dec 14, 2021

Description

Write a genuine contributing guide that works like a fallback for all the repos.

Include Sections like

  • Reporting good bugs
  • Reporting good feature requests
  • Cloning the project & creating pr
  • Branch naming convention (type-description-issueNo, ex: docs-contributing-guide-2)
  • Commit message guideline (conventional commits)
  • A small & concise reviewer guide
  • Link to our community

Anything else?

You can take inspiration from:

Code of Conduct
@gptkrsh gptkrsh added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work good first issue New-contributor friendly ⭐ goal: addition Addition of new feature 🏁 status: ready for dev Ready for work 📄 aspect: text Concerns the textual material in the repository 🟨 priority: medium Not blocking but should be fixed soon and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Dec 14, 2021
@DhansAL
Copy link

DhansAL commented Dec 14, 2021

i'll take this

@gptkrsh
Copy link
Member Author

gptkrsh commented Dec 14, 2021

Sure @DhansAL 👍 Go for it 🚀

@Abhirv08
Copy link
Contributor

@DhansAL Are you working on this issue?

@DhansAL
Copy link

DhansAL commented Dec 25, 2021 •
edited

@Abhirv08 you can take it ^_^ it'll be a great help.

@gptkrsh
Copy link
Member Author

gptkrsh commented Dec 26, 2021

@Abhirv08 Do you wanna get assigned to this?

@Abhirv08
Copy link
Contributor

@krishguptadev sure.

@Abhirv08
Copy link
Contributor

@krishguptadev please tell me what to write in small & concise reviewer guide and please provide community link.

@gptkrsh
Copy link
Member Author

gptkrsh commented Dec 28, 2021

@krishguptadev please tell me what to write in small & concise reviewer guide and please provide community link.

A reviewer guide should include things like how to review, how to suggest changes and more...

Community link: https://dsc.gg/ceruleancoders

@Abhirv08
Copy link
Contributor

@krishguptadev I am not getting what to write in review section, please help me out.

@gptkrsh
Copy link
Member Author

gptkrsh commented Dec 29, 2021

@krishguptadev I am not getting what to write in review section, please help me out.

Aight! You can write the rest of the guide, I'll write the reviewer guide.

@Abhirv08
Copy link
Contributor

@krishguptadev Thank you

@sauradip007
Copy link

@krishguptadev is this issue been taken up?

@gptkrsh
Copy link
Member Author

gptkrsh commented Jan 11, 2022

@sauradip007 Sorry this has been already completed :D

@gptkrsh gptkrsh closed this as completed Jan 11, 2022
@gptkrsh gptkrsh mentioned this issue Feb 22, 2022
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Abhirv08 Abhirv08

Labels
📄 aspect: text Concerns the textual material in the repository ⭐ goal: addition Addition of new feature good first issue New-contributor friendly 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for dev Ready for work
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@sauradip007 @DhansAL @Abhirv08 @gptkrsh