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

feat: update contributing guide #288

Merged
merged 6 commits into from
Apr 4, 2024
Merged

feat: update contributing guide #288

merged 6 commits into from
Apr 4, 2024

Conversation

adiati98
Copy link
Member

Description

This PR updates contributing guide with the following changes:

  • Rewording an instruction to emphasize that creating a new branch is a must.
  • Add an information that maintainers may unassign contributors and close their PR if they take more than one good first issue.
  • Add Docusaurus special admonition syntax to highlight notes, infos, etc.

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

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #287

Mobile & Desktop Screenshots/Recordings

Before

Before applying admonition syntax

After

Admonition highlight

Steps to QA

  1. Pull this branch.
  2. Run the project locally.
  3. Go to http://localhost:3000/contributing/introduction-to-contributing/

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] Are there any post-deployment tasks we need to perform?

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

@adiati98 adiati98 requested a review from a team as a code owner March 28, 2024 19:29
@adiati98 adiati98 self-assigned this Mar 28, 2024
@netlify Netlify
Copy link

netlify bot commented Mar 28, 2024 •
edited
Loading

✅ Deploy Preview for docs-open ready!

Name Link
🔨 Latest commit 3984caa
🔍 Latest deploy log https://app.netlify.com/sites/docs-open/deploys/660d9ada70486d0008ca8d15
😎 Deploy Preview https://deploy-preview-288--docs-open.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@adiati98
Copy link
Member Author

@BekahHW I have a note here.

The syntax for the "danger" one is actually warning (line 87). But it somehow renders as danger. It should be rendered as warning like on the Docusaurus docs.

Hopefully, updating the Docusaurus in the future will resolve this. I included screenshots of before and after in the PR form. So, if you want me to change the "danger" to what we had previously, please let me know.

Thanks!

BekahHW
BekahHW requested changes Apr 3, 2024
View reviewed changes
Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of things to break up the special notes.

docs/contributing/introduction-to-contributing.md Outdated Show resolved Hide resolved
docs/contributing/introduction-to-contributing.md Outdated Show resolved Hide resolved
@adiati98
Copy link
Member Author

adiati98 commented Apr 3, 2024 •
edited
Loading

@BekahHW I made the changes here based on your suggestions.

One note, I moved the note for maintainer as part of point 9 as below screenshot because it talks about PR form. So, it make more sense to have this note as part of this point.

But let me know if you want me to move it back to after the warning (danger) highlight. Thanks! :)

note for maintainers

@adiati98 adiati98 requested a review from BekahHW April 3, 2024 18:11
@BekahHW BekahHW merged commit 1655c76 into main Apr 4, 2024
11 checks passed
@BekahHW BekahHW deleted the feat/update-contrib-guide branch April 4, 2024 18:38
github-actions bot pushed a commit that referenced this pull request Apr 4, 2024
@adiati98 @open-sauced
chore(release): 1.70.0 [skip ci]
be9328c 
## [1.70.0](v1.69.0...v1.70.0) (2024-04-04)

### Features

* update contributing guide ([#288](#288)) ([1655c76](1655c76))
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

🎉 This PR is included in version 1.70.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request Apr 4, 2024
@BekahHW
feat: update contributing guide (#288)
8656631 
* fix: update point 1 and 2 to emphasize creating a new branch

* feat: add rules for PRs that will be marked as invalid

* feat: apply special admonitions syntax

* feat: add additional information to a note

* fix: move info about DMs to community section

* fix: revert info for maintainers to be a quote 1655c76
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BekahHW BekahHW BekahHW approved these changes

Assignees

@adiati98 adiati98

Labels
📝 documentation released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature: Update "Introduction to Contributing"
2 participants
@adiati98 @BekahHW