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.

Sign up for GitHub

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

Jump to bottom

docs(contribution-guidelines): add best practices as a subsection #104

Closed
JeremyFriesenGitHub opened this issue Sep 12, 2024 · 4 comments · Fixed by #112
Closed

docs(contribution-guidelines): add best practices as a subsection #104

JeremyFriesenGitHub opened this issue Sep 12, 2024 · 4 comments · Fixed by #112
Assignees
@AshwinSri23
Labels
good first issue Good for newcomers

Comments

@JeremyFriesenGitHub
Copy link
Contributor

JeremyFriesenGitHub commented Sep 12, 2024 •
edited
Loading

What feature should we improve? Please describe.
We need to add a best practices subsection in the coding contribution guidelines. This would showcase new developers / external contributors the best way / practices to contribute code for cuHacking. This also sets a standard for other developers and overall generally documents. Best practices would be focused on creating sections for testing, docs, features, frontend, backend and much more to show case the standard when it comes to making commits in the cuHacking project.

Describe the solution you'd like

  • Implement a best practices subsection to showcase the best way and/or examples of how to contribute for cuHacking.

Additional context
When working with new contributors, we need to be ready with standard guidelines that are well-documented so that they can be properly on-boarded and can contribute meaningfully to cuHacking.
@AshwinSri23 AshwinSri23 mentioned this issue Sep 17, 2024
Merged
@AshwinSri23 AshwinSri23 linked a pull request Sep 17, 2024 that will close this issue
docs(contribution-guidelines): add best practices section for coding guidelines #112
Merged
@AshwinSri23
Copy link
Contributor

AshwinSri23 commented Sep 17, 2024 •
edited
Loading

@cloverzer0 @MFarabi619 @JowiAoun
I have currently been given the task to get information on best practices for different areas of cuHacking's infrastructure. If possible, I would like to discuss with each of you the guidelines that you follow as a part of your work. Please reach out to me by replying to this comment.

@MFarabi619
Copy link
Member

Hey @AshwinSri23, for sure; thanks for taking this on. As we wrap up our scaffolding work, the volume of code we're pumping out is rising pretty fast. Did you want to do this synchronously or asynchronously?

We currently have a docs site, which is pretty much always a work-in-progress and serves as our single source of truth for all of our best practices and documented patterns.

@AshwinSri23
Copy link
Contributor

AshwinSri23 commented Sep 17, 2024 •
edited
Loading

I don't mind doing either. If you would like to contact me asynchronously, you can direct message me on discord. My username is ash6843. Alternatively, we could try and schedule a meeting either sometime this week or next week.

Any information that I get from any of you on best practices would be added to the docs site. I have made a draft pull request for this. Here is the link to it: #112

@MFarabi619
Copy link
Member

Sounds good thanks Ashwin, let me get back to you. Hasith should already be in touch.

@JeremyFriesenGitHub JeremyFriesenGitHub added the good first issue Good for newcomers label Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AshwinSri23 AshwinSri23

Labels
good first issue Good for newcomers
Projects
🐞 2025
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(contribution-guidelines): add best practices section for coding guidelines cuhacking/2025
4 participants
@MFarabi619 @AshwinSri23 @HasithDeAlwis @JeremyFriesenGitHub