open-sauced / guestbook Goto Github PK
View Code? Open in Web Editor NEWThe place where future contributors are born
License: Other
The place where future contributors are born
License: Other
π Feature
I want to make my first contribution.
I would like to add myself as a contributor to the guestbook.
No response
π Documentation
I want to do my first contribution to the roject
I would like to add my name to the contribution list
No response
π Feature
Contributors have been skipping the screenshot section when filling out their PR form. Itβs mostly likely due to assuming thatβs itβs not required inspite of the course mentioning that itβs needed.
.github
folderPull Request
fileScreenshot
, write "(*Required before Pull Request is Reviewed)"No response
Important
If you've worked on a good first issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.
Below logo in this repo's README is the old one. We should replace it with the new one: https://github.com/open-sauced/assets/blob/main/logos/logo-on-dark.png.
Update the <img>
by replacing it with this line:
<img alt="OpenSauced" src="https://github.com/open-sauced/assets/blob/main/logos/logo-on-dark.png">
Line to be changed:
Line 3 in 10db621
The 'Getting Started' link for a 'docs' issue : https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=getting-started leads to a 404 error.
π Feature
There is not a CODEOWNERS file.
We can essentially replicate what we have in the pizza-verse
repo: https://github.com/open-sauced/pizza-verse/blob/main/.github/CODEOWNERS
No response
We have an extra tr
I haven't had a change to look at the code, but you should be able to find it in the readme. Remove the extra tr.
No response
No response
As part of the Intro to Open Source course, we are encouraged to contribute to this repo.
Add myself as a contributor
There are two types of contrubutions to this repo:
We've been successful with the docs for the first. Let's improve the docs for the second.
To do this, we need to explain how to run the project locally: https://github.com/open-sauced/intro/blob/main/CONTRIBUTING.md.
I'm in favor of adding this CONTRIBUTING.md file to our repo and linking in our readme with an explanation that if you're interested in contributing to improve this course, please create an issue and refer to this guide.
Outside of Hacktoberfest, most contributors who contribute to this repo are participants of our Intro to Open Source course. So I propose to remove the "Getting Started" and "Update Branch & Resolve Conflicts" sections and move them to the Intro to Open Source course.
Moving these sections to the course will give 2 benefits:
This issue is depending on this PR in the intro repository.
I noticed two issues in regards to the translation guide:
i18tn-guidelines.md
file is labeled incorrectly.community guidelines
i18tn-guidelines.md
file and see the wrong file nameOther (add additional context)
N/A
The content in the Running the Project Locally section in the Contributing Guide is meant for the intro
repo.
This project is not built on Docsify.
Remove the section from the Contributing Guideline.
Below are the code blocks for this section:
Lines 37 to 76 in d2629d6
We have a section in the CONTRIBUTING.md
called Adding a New Section to the Documentation.
This section is no longer needed as it's specific for intro repository and we have removed the subsections from this repo's Contributing Guide.
Remove the section from Contributing Guide.
Below is the code block for the section that needs to be removed:
Lines 77 to 80 in d2629d6
π Feature
The guestbookβs instructions has not been translated yet, so we needed to make some changes to the first section of the translation guide
.
translation guide
.(To Be Announced)
next to each bullet point.No response
π Documentation
Based on our conversations in PR #202, there are more adjustments that the Contributing.md
file needs in order to be guestbook-focused.
The following section is needed for improvement:
I want to work on this issue
As part of the Intro to Open Source course, we are encouraged to contribute to this repo
Add myself as a contributor
π Documentation
When filling out the form for docs-related PRs, I found myself struggling with answering some of the questions and connecting the corresponding issue to it. A similar phenomenon could happen for people who want to do translation contributions or improve the directions in the README and Contributing files.
[] Not applicable
checkbox in the Contributors Checklist section[] π CONTRIBUTING.md
checkbox in the Added to Documentation section.## Closes Issue
section after the What Type of PR is this? sectionNo response
As we are adjusting our Contributing Guide to be only be about contributing to improve this repository, we would also adjust some of the wording in the guide.
Originally posted by @BekahHW in #202 (comment)
Add this sentence as an opening line for the guide.
This Contributing Guide will walk you through how to contribute to this project for bug fixes and features. If you want to contribute to the guestbook, please refer to chapter five of the Intro to Open Source course.
Fix the wording of step 3 in the "Setup the Project Locally" as below:
Navigate to and open the project in your code editor.
Line 29 in d2629d6
Remove step 4 in the "Setup the Project Locally".
Line 35 in d2629d6
Update the numbering to reflect the changes
Method 2: Using Visual Studio Code (VS Code) Go Live Feature
As part of the Intro to Open Source course, we are encouraged to contribute to this repo
No response
We received a handfull of PRs that missed the step of generating profile and badge on the README.
Add a section of "Screenshot" after the "Added to documentation?" to the PR template. There will be an explanation here that contributors need to provide a screenshot of their profile being generated on README. This will ease maintainers in reviewing PRs and ensure contributors to run the generate command.
Important
If you've worked on a good first issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.
We had a major update to our Intro to Open Source course that caused the changes of the links.
In the .github/ISSUE_TEMPLATE/add_contributor.yml
, change the link to the "Getting Started" section in a checkbox's description as follow:
https://intro.opensauced.pizza/#/intro-to-oss/how-to-contribute-to-open-source?id=getting-started.
Line that needs to be changed:
When contributors add themselves manually, they should follow the emoji key and contribution types. Not following this list will break the process of generating README and the following PRs.
As there will be changes in the README, we might as well improve it.
Certain parts of the CONTRIBUTING.md
file in this repository follows the one (https://github.com/open-sauced/intro/blob/main/CONTRIBUTING.md) in the intro
repository. This can create confusion amongst contributors.
In the CONTRIBUTING.md
file, omit the following:
> @CBID2 I did look into Crowdin. I think we need to make sure there's interest. I'm super excited to have folks interested in translating, but we need to gauge how many people are _using_ the translated versions as part of the discussion. Maybe we should consider adding something to the PR template to ask them to select the language they used to complete the task.
That's a great idea! :) I do a PR for that part if you'd like.
Originally posted by @CBID2 in #79 (comment)
Learning about github and open source.
No response
As part of the Intro to Open Source course, we are encouraged to contribute to this repo.
Add myself as a contributor.
Currently, in the step 7 of the Getting Started section we have this:
7. If you used the CLI tool method in step 6, to add yourself to the guestbook, ...
It should be step "5" instead of "6".
This can be misleading, so we need to fix it.
Other (add additional context)
N/A
π Documentation
Step 7 in the Getting Started section of the README file uses commit -am "Your message"
. However, it doesn't explain what that commit does. Since this repo is aimed at people who finished the intro course, contributors might not be too comfortable with using this command yet.
Provide a brief explanation of this commit.
No response
As a part of the Intro to Open Source course, we are encouraged to practically practice open source by contributing to this repo.
Add my username to this repo as a contributor.
As a part of learning about Open Source Contribution, there is a requirement of adding a new contributor @rohitkrsoni so that I can do my first open source contribution.
No response
As part of the Intro to Open Source course, we are encouraged to contribute to this repo.
Add myself as a contributor
π Feature
A common issue that has been going with this repository is merge conflicts.
It would be beneficial to add a section on updating branches and solving merge conflicts to the Contributing Guide. That way, contributors can access this information quickly and gain some practice.
As far as structure goes, I'm thinking of modeling after the subsection in the Pizza Verse Repo.
No response
π Feature
This repository is using CLI to add contributors to the README.md
file.
However, there is also a suggestion in the README:
... we recommend actually editing the
.all-contributorsrc
file to get more experience with pull requests and reviews.
Does this mean that we are suggesting contributors to add themselves manually in the file?
If we want to encourage contributors to add themselves manually to the file, we also want to provide instructions on how to do so.
No response
π Documentation
Semantic reading of step 7.
A user would have already run the command:
' git commit -am "your message" '
before reading: 'You can skip this step(7) if you use the CLI..
Change "Your message" to your own message. For example, "Add Alice to the guestbook".
please assign me to update instruction step 7 of the README.md file
I hope that this reads better sematically
π Feature
The guestbook directions are written only in English, which can make new open source contributors, especially those who have English as a second language or do not speak it all.
In the spirit of @antonio-pedro99's suggestion in issue #16 of the intro course's repo, I think it would be helpful to have the directions for the guestbook in Portuguese.
No response
π Feature
There has been a recurring issue with contributors pushing their contributions to the repoβs main branch, making the project vulnerable to breaks.
It would be best to add put a protection rule for the main branch.
Per GitHubβs documentation for branch protection rules, do the following:
No response
npm run contributors:add
is not working as expected and is showing error in the terminal
Fork and clone the repository and try npm run contributors:add
command
No response
No response
Important
If you've worked on a good first issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.
WIth the major update to the Intro to Open Source course, the links on the website are also changed. So, we need to update the links to the course in the README of guestbook repo.
Below, you will find the lines that need to be updated and how they need to be updated.
Line 12 in 10db621
[Intro to Open Source course](https://intro.opensauced.pizza/#/intro-to-oss/README)
Line 16 in 10db621
"[Let's Get Practical](https://intro.opensauced.pizza/#/intro-to-oss/how-to-contribute-to-open-source?id=let39s-get-practical)"
Line 20 in 10db621
"[Merge Conflicts in the Guestbook Repository](https://intro.opensauced.pizza/#/intro-to-oss/how-to-contribute-to-open-source?id=merge-conflicts-in-the-guestbook-repository)"
Line 32 in 10db621
[Contributing Guidelines](https://github.com/open-sauced/intro/blob/main/docs/CONTRIBUTING.md)
Currently, we have CODEOWNERS file that contains the list of code owners. But they don't get added automatically as reviewers as it suppposed to. And it happens because the syntax has to be on the same line.
Can't be reproduced without a new incoming PR.
No response
No response
Important
If you've worked on a good first issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.
We have updated the "Getting Started" section on our Intro to Open Source course as following:
Therefore, we need to update the PR template to reflect this update.
Additionally, we also want to remind contributors to complete the PR form.
Add a comment on the first line with the copy below.
<!-- Please fill in all areas in this PR form. Incomplete PRs will be marked invalid and may be closed. -->
Add a new section for related issues right after "What type of PR" section. Use the copy below.
## Related Issues
<!--
Please use this format link issue numbers: Closes #123
More information: https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->
Update wording in the "Contributing Checklist" section with the below suggestion.
- ## Contributors checklist (check all applicable)
+ ## Contributors checklist
Remove the below sections.
guestbook/.github/PULL_REQUEST_TEMPLATE.md
Lines 20 to 29 in 20aeca1
π Feature
The process of adding contributors to this repository gives high potential of resolving conflicts before PR can be merged. It happens because new contributors will always add themselves at the end of the contributors array.
No response
There are incorrect links in the README. Also, we want to have consistency with the term "guestbook".
Change all "guest book" term to "guestbook" on the README. If it starts with capital letter, keep the capital letter.
Update links and some wording in the code snippet with the suggestion following the snippet:
Line 12 in a425e26
This guestbook is a place for people who have taken [OpenSauced](https://app.opensauced.pizza/)'s [Intro to Open Source course](https://intro.opensauced.pizza/#/) to take their first steps into contributing to open source.
Line 20 in a425e26
If you encounter merge conflicts while contributing to this repository, read our Intro to Open Source course's "[Merge Conflicts in the Guestbook Repository](https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=merge-conflicts-in-the-guestbook-repository)" section.
Line 24 in a425e26
You can add this contribution to your [Highlight](https://app.opensauced.pizza/feed) at OpenSauced! Read our docs to learn more about [Highlight feature](https://docs.opensauced.pizza/features/highlights/).
Line 26 in a425e26
Hungry for more contributions? Check out our [pizza-verse](https://github.com/open-sauced/pizza-verse) repository and join us in celebrating pizza!π
Line 30 in a425e26
All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please follow our [Contributing Guidelines](CONTRIBUTING.md) for contributing.
Line 32 in a425e26
- **Course improvement**: If you are interested in improving OpenSauced's Intro to Open Source course, please create an issue at our [intro repository](https://github.com/open-sauced/intro) and refer to the [Contributing Guidelines](https://github.com/open-sauced/intro/blob/main/CONTRIBUTING.md).
To get our "Intro to Open Source" course participants into the flow of contributing to open source, we want them to learn and experience creating an issue and link their PR to it later on.
Originally, we will let contributors to create an issue from scratch. However, adding an issue template would be a good practice for them to learn about issue's structure.
Based on these discussions:
To make it easier for contributors and maintainers to triage, let's create a simple issue template with below sections and add instructions (coment them out) to each section:
1. Create an ISSUE_TEMPLATE
folder inside .github
folder.
2. Create a file call feature_request.yml
.
3. Add these to the template (See our Feature Request template to help you out):
validations: required: true
Atrributes' label in the body:
Description
description: Please describe the issue β for example, "As part of the Intro to Open Source course, we are encouraged to contribute to this repo."
Suggested solution
description: Suggest a solution β for example, "Add myself as a contributor."
Code of Conduct agreement
Getting Started Instructions agreement
type: checkboxes
id: contribution
attributes:
label: Getting Started Instructions
description: Please read [Getting Started](https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=getting-started) to add yourself as a contributor.
options:
- label: I agree to follow this project's Getting Started instructions.
required: true
We have an issue template special to add contributors to guestbook repo. But this template is not listed when we click "New issue" button.
The problem is the ISSUE_TEMPLATE
folder is located inside the .github/workflows
and not on the root of .github
folder.
We also want to rename the issue template to be add_contributor.yml
to distinguish it from feature_request.yml
template.
ISSUE_TEMPLATE
to the root of .github
folder.add_contributor.yml
.No response
No response
As part of the Intro to Open Source course, we are encouraged to contribute to this repo.
Add myself as a contributor.
π Fix
I noticed that the message for first-time contributors is not personalized enough, which can make the experience a bit assembly-line-like.
Instead of:
PR_COMMENT="Congratulations on completing Chapter 5 of the Intro to OSS Course with your contribution to this repository! You're almost to the end of the course. Create a highlight of your contribution to our guestbook using the instructions in chapter 6 and share it with us!"
curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -X POST -d "{"body":"$PR_COMMENT"}" "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/commentsβ
How about:
PR_COMMENT="Congratulations on completing Chapter 5 of the Intro to OSS Course with your contribution to this repository @${{ github.actor }}! You're almost to the end of the course. Create a highlight of your contribution to our guestbook using the instructions in chapter 6 and share it with us!"
curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -X POST -d "{"body":"$PR_COMMENT"}" "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"
It'll make the contributor feel more welcomed.
No response
I tried running the npm run contributors:add
command locally, and ran into this error
Error: Unknown contribution type web development for contributor
Here is the complete screenshot
The error is happening because web development is not a valid entry for the contributions array
"contributions": [
"web development"
]
the fix would be to change that to code
since that is a valid entry
"contributions": [
"code"
]
But also, for the long term it might be nice to have an additional check in place to double check that the contributions array only holds valid values.
That way if a user tries to contribute to the guestbook manually with an invalid value, then the check will catch that.
npm run contributors:add
commandNo response
No response
As part of the Intro to Open Source course, we are encouraged to contribute to this repo.
Add myself as a contributor.
π Feature
Currently, we're using the default PR template that lives in our .github
repository for this repo.
However, there are some sections and points that aren't needed here, such as:
Based on the default template, create a PR template in the .github
folder with related contents for this repo:
npm run contributors:generate
?No response
Our bot is overly aggressive.
See this PR #180
No response
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.