docs: adjust Contributing file #202

CBID2 · 2023-12-20T23:30:11Z

Description

Certain parts of the CONTRIBUTING.md file in this repository follow the one in the intro repository, which can create confusion amongst contributors.
So, this PR does the following:

Omits the information about adding a new section to a sidebar, and revises the process of finding the documentation files.
Revises Markdown formatting

Related Issues

Closes #201

What type of PR is this? (check all applicable)

🤝 Add a contributor
📝 Documentation Update

Contributors checklist (check all applicable)

Have you read the Getting Started section thoroughly?
- ✅ Yes
- ❌ Not yet
- N/A
How did you add yourself as a contributor?
- 🤖 With CLI
- ⌨️ Manually
- N/A
  
  If you added yourself manually, did you follow the emoji key and contribution types to fill in the value?
  - ✅ Yes
  - ❌ No
  - N/A
Have you run npm run contributors:generate to generate your profile and the badge on the README?
- ✅ Yes
- ❌ No
- N/A

Added to documentation?

📜 README.md
🙅 no documentation needed

Screenshot

[optional] What GIF best describes this PR or how it makes you feel?

…trokes

CBID2 · 2023-12-21T00:22:44Z

CONTRIBUTING.md


 ## Using Markdown for Documentation
-Markdown is a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way. When contributing to the Intro Course, it's important to use Markdown to structure and format your content effectively.
+
+Markdown is a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way. When contributing to the documentation in this repository, it's important to use Markdown to structure and format your content effectively.


Not a fan of how this paragraph is worded. Any suggestions on how to improve it @adiati98 and @BekahHW?

@CBID2 what about it are you not a fan of? Can you be more specific?

It seems a bit repetitive @BekahHW. I'll address it in other issue and its corresponding PR.

CONTRIBUTING.md

adiati98

@CBID2 I think most of sections here are for intro repo.

@BekahHW I need confirmation if we want to have intro's contributing guide in this guestbook repo.

adiati98 · 2023-12-21T12:38:23Z

CONTRIBUTING.md

@@ -17,39 +18,50 @@ If you are contributing to the project for the first time, please consider check
 In case you get stuck, please feel free to ask for help in the [Discord](https://discord.com/invite/U2peSNf23P) server or GitHub Discussions.

 ## Setup the Project Locally


This section is to setup intro locally, and not guestbook. Guestbook doeesn't required to run docsify.
But is this what we want in this guide?

Oh yeah, I forgot about that @adiati98 🤦‍♀️ Ideally, it would be a good idea to have beginners learn how to set up their forks locally, but since the guestbook is simple, I think it would be best to modify it. They can learn how to do local setups in other repos like the intro and docs.

Hmm... We have a getting started section in the intro course to fork and clone repo.

True @adiati98. Maybe we can put a link to that section? It could serve as a refresher. :)

But would love to hear your idea about how to modify it.

@BekahHW, we're now in the guestbook repository. And this section is walking through the steps on how to setup docsify, which is not needed in this repository.

We might want to remove this in the next update.

@adiati98, right. The contributing guide for the guestbook should only include information about contributing to improve the repository. For directions on how to add yourself, that would be found in the intro course, right?

I'm thinking that maybe another option would be like we do at Virtual Coffee with issue 13 (members adding themselves); we have a pinned issue here to add yourself to the repo, but the issue links to the chapter in the course.

That's a good idea @BekahHW! :)

@BekahHW, right. The directions on how to add yourself is found in the intro course, in Let's Getting Practical section.

We can do forever-open issue like VC. So, we add an open issue, and contributors can write Relates to #000 instead of Closes #000 on their PR. I think we're doing that as well in pizza-verse.

The problem with that (based on experience with VC) is sometimes, we need to reopen the issue because contributors who quite understands how OSS works use closes or fixes instead of mentioning the issue.

Another way is, we have a point to find or create an issue in the Getting Started With Contributing in our intro course. I think it would be great to put it into practice in this guestbook repo with these reasons:

Beginners learn how to open an issue (with templates).

They learn how to link a PR with an issue and can experience the issue & PR close automatically.

I second this

adiati98 · 2023-12-21T12:41:56Z

CONTRIBUTING.md

@@ -63,119 +75,131 @@ This will open your documentation in a new browser tab at a local address (typic
 7. **Stop the Live Server**: When you're done testing or making changes, you can stop the Live Server by clicking the "Exit" button in the VS Code status bar.

 ## Adding a New Section to the Documentation


This section is to add a new section to the intro course, and not guestbook.

True @adiati98. I just need to figure out a new name to make it fit the guestbook. Any suggestions?

It's not only the title, @CBID2.
Looking at the content in this section, this also for intro.
Guestbook doesn't require adding new section.

Do you think it should be deleted then @adiati98?

@CBID2, from reading the issue, that's what should happen in this PR. We should only be eliminating the two sections there. So that section becomes obsolete.

adiati98 · 2023-12-21T15:55:59Z

@CBID2 @BekahHW
If we want to adjust the Contributing Guide to serve guestbook repo, I see an opportunity here to implement our discussion:

Reminder to take screenshots after generating the README.
Completing the PR form.
Fix resolving conflicts immediately.

Another thought I have is for beginners to learn and practice how to create an issue and link it to the PR.

We don't need to create an issue template for this. Rather, they learn how to create issue from scratch and link their PR to it, so it will be closed automatically once the PR is merged.

Any feedback is appreciated! 😊

CBID2 · 2023-12-21T16:28:10Z

@CBID2 @BekahHW
If we want to adjust the Contributing Guide to serve guestbook repo, I see an opportunity here to implement our discussion:

Reminder to take screenshots after generating the README.

Completing the PR form.

Fix resolving conflicts immediately.

Another thought I have is for beginners to learn and practice how to create an issue and link it to the PR.

We don't need to create an issue template for this. Rather, they learn how to create issue from scratch and link their PR to it, so it will be closed automatically once the PR is merged.

Any feedback is appreciated! 😊

Hi @adiati98. The first three suggestions are great, especially the ones on fixing merge conflicts. Now as far as the issue activity goes, that's a good one.There could be something like, "go through the repo and use the following categories to create your issue". What do you think?

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

BekahHW

@CBID2 let's try to stick to the issue description. There are things going on here that are not covered in the issue. Can you cover what's in the issue and then open up another PR for any additional changes you want to make?

CBID2 · 2023-12-22T18:58:32Z

@CBID2 let's try to stick to the issue description. There are things going on here that are not covered in the issue. Can you cover what's in the issue and then open up another PR for any additional changes you want to make?

Hey @BekahHW. Yeah I'll do that. The other stuff came up as I was reviewing the doc.

CBID2 · 2023-12-23T01:14:56Z

Hi @BekahHW and @adiati98, I omitted the content I mentioned in #201 just like you suggested and added the info you mentioned here. I think we should merge it like this for now so it the PR correlates to the issue that it addresses. From there, I'll continue making adjustments to it based on issue #205. Sound good?

CBID2 · 2024-01-04T17:41:03Z

@BekahHW or @adiati98, can one of you approve this PR? I want to move on to the other stuff we discussed

adiati98

Hey @CBID2,
I left some review here. :)

CONTRIBUTING.md

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

…ith intro repo

adiati98

I'm approving this PR for now, with some notes that I will address in new issue(s). 👍

Thanks, @CBID2!

Requirements met

docs: adjust Contributing file

1258f76

CBID2 self-assigned this Dec 20, 2023

CBID2 requested a review from adiati98 December 20, 2023 23:30

CBID2 and others added 5 commits December 20, 2023 18:30

Merge branch 'main' into adjusting-docs

0277a85

docs: bolded list numbers in Markdown Basics section and improve keys…

b219364

…trokes

docs: made more formatting edits

08ac5ed

feat: more edits

b8e9db5

docs: change numbering

0b41c1c

CBID2 commented Dec 21, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CBID2 added 3 commits December 20, 2023 19:30

fix: revise snippet formats

e4f0ee3

fix: made more revisions

edbad7c

fix: change snippet format

059752d

CBID2 added the documentation Improvements or additions to documentation label Dec 21, 2023

docs: fix hyperlinks

2a9437d

adiati98 reviewed Dec 21, 2023

View reviewed changes

Update CONTRIBUTING.md

ac80b73

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

BekahHW previously requested changes Dec 22, 2023

View reviewed changes

fix: omitted step-by-step-guide to adding new documentation

7419ffc

CBID2 mentioned this pull request Dec 23, 2023

docs: more adjustments needed in Contributing.md file #205

Closed

2 tasks

Merge branch 'main' into adjusting-docs

5af3f2b

elfajriharsuda approved these changes Dec 26, 2023

View reviewed changes

CBID2 marked this pull request as ready for review December 26, 2023 17:04

adiati98 mentioned this pull request Jan 3, 2024

docs: more adjustments to the PR template #203

Closed

2 tasks

adiati98 requested changes Jan 4, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CBID2 and others added 6 commits January 4, 2024 13:49

fix: change code snippet

c5d193f

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

fix: change a code snippet

f7684d8

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

fix: keep code snippet the same as the one in the intro repo

9a41e2e

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>

fix: indentation and update Markdown Basics section for consistency w…

84fd391

…ith intro repo

fix: link to run project locally

fca9492

fix: minor wording

ceaccc5

adiati98 approved these changes Jan 4, 2024

View reviewed changes

adiati98 merged commit d2629d6 into open-sauced:main Jan 4, 2024
1 check passed

adiati98 mentioned this pull request Jan 4, 2024

Docs: Adjust wording in the Contributing Guide #209

Closed

4 tasks

CBID2 deleted the adjusting-docs branch January 4, 2024 20:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: adjust Contributing file #202

docs: adjust Contributing file #202

CBID2 commented Dec 20, 2023 •

edited

CBID2 Dec 21, 2023

BekahHW Dec 22, 2023

CBID2 Dec 23, 2023 •

edited

adiati98 left a comment

adiati98 Dec 21, 2023

CBID2 Dec 21, 2023 •

edited

adiati98 Dec 21, 2023

CBID2 Dec 21, 2023

adiati98 Dec 21, 2023

adiati98 Dec 23, 2023 •

edited

BekahHW Jan 3, 2024

CBID2 Jan 3, 2024

adiati98 Jan 3, 2024 •

edited

CBID2 Jan 3, 2024

adiati98 Dec 21, 2023

CBID2 Dec 21, 2023

adiati98 Dec 21, 2023

CBID2 Dec 21, 2023

BekahHW Dec 22, 2023

adiati98 commented Dec 21, 2023

CBID2 commented Dec 21, 2023

BekahHW left a comment

CBID2 commented Dec 22, 2023

CBID2 commented Dec 23, 2023 •

edited

CBID2 commented Jan 4, 2024

adiati98 left a comment

adiati98 left a comment

		@@ -17,39 +18,50 @@ If you are contributing to the project for the first time, please consider check
		In case you get stuck, please feel free to ask for help in the [Discord](https://discord.com/invite/U2peSNf23P) server or GitHub Discussions.

		## Setup the Project Locally

		@@ -63,119 +75,131 @@ This will open your documentation in a new browser tab at a local address (typic
		7. Stop the Live Server: When you're done testing or making changes, you can stop the Live Server by clicking the "Exit" button in the VS Code status bar.

		## Adding a New Section to the Documentation

docs: adjust Contributing file #202

docs: adjust Contributing file #202

Conversation

CBID2 commented Dec 20, 2023 • edited

Description

Related Issues

What type of PR is this? (check all applicable)

Contributors checklist (check all applicable)

Added to documentation?

Screenshot

[optional] What GIF best describes this PR or how it makes you feel?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CBID2 Dec 23, 2023 • edited

Choose a reason for hiding this comment

adiati98 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CBID2 Dec 21, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiati98 Dec 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiati98 Jan 3, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiati98 commented Dec 21, 2023

CBID2 commented Dec 21, 2023

BekahHW left a comment

Choose a reason for hiding this comment

CBID2 commented Dec 22, 2023

CBID2 commented Dec 23, 2023 • edited

CBID2 commented Jan 4, 2024

adiati98 left a comment

Choose a reason for hiding this comment

adiati98 left a comment

Choose a reason for hiding this comment

CBID2 commented Dec 20, 2023 •

edited

CBID2 Dec 23, 2023 •

edited

CBID2 Dec 21, 2023 •

edited

adiati98 Dec 23, 2023 •

edited

adiati98 Jan 3, 2024 •

edited

CBID2 commented Dec 23, 2023 •

edited