Skip to content

Added build step to prepare script #7713

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

FarazzShaikh
Copy link

Added build step to prepare script and Removed redundant calls of build script

Why:

Closes #222

What's being changed:

Check off the following:

  • I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click View deployment).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@FarazzShaikh FarazzShaikh requested a review from a team as a code owner June 26, 2021 08:27
@welcome
Copy link

welcome bot commented Jun 26, 2021

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

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 26, 2021
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions. The complete list of files we can't accept are:
.github/actions-scripts/**
.github/workflows/**
.github/CODEOWNERS
assets/fonts/**
data/graphql/**
lib/graphql/**
lib/redirects/**
lib/rest/**
lib/webhooks/**
scripts/**
translations/**

You'll need to revert all of the files you changed in that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

@github github deleted a comment Jun 27, 2021
@github github deleted a comment Jun 27, 2021
@github github deleted a comment Jun 27, 2021
@janiceilene
Copy link
Contributor

@FarazzShaikh Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilene janiceilene added engineering Will involve Docs Engineering and removed triage Do not begin working on this issue until triaged by the team labels Jun 27, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2021

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Jul 5, 2021
@ramyaparimi ramyaparimi added waiting for review Issue/PR is waiting for a writer's review and removed stale There is no recent activity on this issue or pull request labels Jul 7, 2021
@janiceilene
Copy link
Contributor

Thanks for opening this PR @FarazzShaikh! Sometimes we need to run packages without making a build, having to build to install would be a deal breaker for some processes, so we can't accept this PR.

Thanks so much for your interest and passion in improving the GitHub docs 💛

@FarazzShaikh
Copy link
Author

@janiceilene thank you for your review. You should close #222 as well if this cannot be implemented.

@JamesMGreene
Copy link
Member

@FarazzShaikh We really appreciate the PR you offered up. 🙇🏻‍♂️

Unfortunately, when the larger team reviewed your PR, one of the valid issues mentioned was that this change (adding a prepare script to run the npm run build script) would've forced us to always run the build, even when we don't want or need to, and thus slowing down certain processes (e.g. in many of our Actions workflows). That was a perspective that I hadn't considered when I encouraged you to create this PR. 😓

Since npm does not currently provide us a mechanism to opt-out of that behavior (other than --ignore-scripts, which also ignores all of the dependencies' lifecycle scripts, too 😬 🙅🏻‍♂️), we decided it was better for us to stick with the opt-in behavior that we currently have. While we understand that does put a slight burden on contributors to execute that one extra step, we believe it is something that is easily enough learned and worked around. 🤷🏻‍♂️

Thank you especially for your thoroughness in taking the extra step of updating the contributor documentation, the Codespaces configuration, and the Actions workflows as well. ✨

We are thankful for your involvement and effort. We would love to see additional contributions from you in the future. ❤️

@FarazzShaikh
Copy link
Author

Understood, Thanks for letting me know! 😄

@FarazzShaikh FarazzShaikh deleted the fix__222 branch July 30, 2021 03:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Will involve Docs Engineering waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

first local test run requires npm run build
5 participants