Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: improve contributor experience with setup guide and enhanced gitignore#39247

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
surajsk2003 wants to merge1 commit intogithub:main
base:main
Choose a base branch
Loading
fromsurajsk2003:main

Conversation

surajsk2003
Copy link

Why

Improve the onboarding experience for new contributors by providing clear setup instructions and better project hygiene.


What's Being Changed

EnhancedREADME.md

  • AddedPrerequisites section with Node.js version requirements
  • AddedQuick Start section with step-by-step installation instructions
  • AddedAvailable Scripts section explaining commonnpm commands

Improved.gitignore

  • Included a comprehensive list of common files and directories to ignore
  • Added OS-specific files (.DS_Store,Thumbs.db, etc.)
  • Ignored build artifacts and cache directories

CreatedCONTRIBUTING.md

  • Included a simple setup guide for new contributors
  • Added suggestions for easy first contributions
  • Linked to detailed documentation and community guidelines

Checklist

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR
    In most cases, the author can be the SME. For open source contributions, GitHub staff may review.
  • The changes in this PR meet theDocs content fundamentals.
  • All CI checks are passing and the changes look good in the review environment.

Let me know if any adjustments are required. Happy to improve the experience for future contributors!

@CopilotCopilotAI review requested due to automatic review settingsJuly 10, 2025 01:20
@welcomeWelcome
Copy link

welcomebot commentedJul 10, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out thecontributing guidelines.

@github-actionsgithub-actionsbot added the triageDo not begin working on this issue until triaged by the team labelJul 10, 2025
@github-actionsGitHub Actions
Copy link
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment isautomatically generated.

Copy link
Contributor

@CopilotCopilotAI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the onboarding experience by enhancing the main README with clear setup instructions and introducing a dedicated CONTRIBUTING guide.

  • Expanded README with prerequisites, quick start steps, and script explanations
  • Added aCONTRIBUTING.md with first-time setup, branch workflow, and easy-entry tasks

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

FileDescription
README.mdAddedPrerequisites,Quick Start, andAvailable Scripts sections
CONTRIBUTING.mdNew contributor guide covering setup, change workflow, and help resources
Comments suppressed due to low confidence (4)

README.md:10

  • Use an asterisk (*) instead of a hyphen for bullet lists to comply with the repository's Markdown style guidelines.
- **Node.js**: Version 20 or 22 (see [engines](package.json) in package.json)

README.md:37

  • Switch this list item to use an asterisk (*) instead of a hyphen for consistency with the project content guidelines.
- `npm run dev` - Start development server with English content only

CONTRIBUTING.md:1

  • Replace the hardcoded product name “GitHub Docs” with the corresponding Liquid variable (e.g.{% data variables.product.github %}) to ensure variable-driven consistency across content.
# Contributing to GitHub Docs

CONTRIBUTING.md:54

  • Use an asterisk (*) for this bullet list item instead of a hyphen to align with the Markdown bulleted list convention in our content guidelines.
- Fix typos in documentation

@Sharra-writesSharra-writes added contentThis issue or pull request belongs to the Docs Content team contributing docsContent related to our contributing docs and removed triageDo not begin working on this issue until triaged by the team labelsJul 10, 2025
@Sharra-writes
Copy link
Contributor

Sharra-writes commentedJul 10, 2025
edited
Loading

@surajsk2003 Thanks for opening a PR! One thing to note before I take a closer look at the rest of this: the README is actually meant for internal use, which is why we have a separate contributing doc. The public docs repo and the private docs-internal repo sync several times a day, so all the files have to be exactly the same. That means that files meant primarily for internal use are also available publicly. It is one of my goals to update the README to make it clearer that it's for internal use, because it's pretty bad, but I haven't gotten there yet.

Let me take a look at the rest and maybe check in with the rest of the team, and I'll let you know what we find helpful in your suggestions. 💛

Edit: I've realized, looking at your PR, that our links to our CONTRIBUTING.md have been broken for who knows how long. Which is...great. Anyway, I'm fixing that, andhere is the correct link so you can see what it has and alter that instead of creating your own instance of it.

@surajsk2003
Copy link
Author

Thank you so much for the clarification and your thoughtful response 💛

I completely understand now that theREADME.md is meant for internal use and needs to remain in sync across both the public and private repos. That makes perfect sense — I’ll refrain from modifying it further.

I’ll revise my PR to shift the onboarding and setup-related improvements (like prerequisites, quick start, available scripts, and beginner-friendly suggestions) into the correctCONTRIBUTING.md file instead — based on the updated link you shared.

Also, I’m glad this PR helped uncover the broken link issue — even indirectly! 😄 Please feel free to suggest anything further that could make the contribution more helpful to new developers.

Will update the PR shortly.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

Copilot code reviewCopilotCopilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
contentThis issue or pull request belongs to the Docs Content teamcontributing docsContent related to our contributing docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@surajsk2003@Sharra-writes

[8]ページ先頭

©2009-2025 Movatter.jp