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

More information needed in Contributing.md instructions for adding upstream fork #446

Closed
demdante opened this issue Oct 14, 2020 · 0 comments · Fixed by #457
Closed

More information needed in Contributing.md instructions for adding upstream fork #446

demdante opened this issue Oct 14, 2020 · 0 comments · Fixed by #457
Labels
0 - _Triaging Issue is accepted, but a milestone has yet to be added for the issue Documentation Issues for changes that only need to change documentation Improvement Issues that enhances existing functionality, or adds new features

Comments

@demdante
Copy link
Contributor

Contributing.md's instructions for adding upstream fork assume that the user has configured git and is using SSH agent forwarding, but many, if not the majority, of users are going to be using https cloning with git instead. It would really help if the instructions also included information on how to add an upstream fork when using git with https cloning.

Is your feature request related to a problem? Please describe.
Kind of, yes. I was unable to correctly follow the instruction outlined in Contributing.md because I had https cloning to clone the repo.

Describe the solution you'd like
It would really help if the instructions also included information on how to add an upstream fork when using git with https cloning.

Describe alternatives you've considered
NA

Additional context
NA
@demdante demdante added 0 - _Triaging Issue is accepted, but a milestone has yet to be added for the issue Improvement Issues that enhances existing functionality, or adds new features labels Oct 14, 2020
@pauby pauby added the Documentation Issues for changes that only need to change documentation label Oct 15, 2020
demdante added a commit to demdante/boxstarter that referenced this issue Nov 19, 2020
@demdante
(chocolateyGH-446) Updates documentation with important info
d830998 
In the current CONTRIBUTING documentation, the method documented for adding the remote assumes that the user is using ssh agent forwarding.  However, most users are going to be using HTTPS cloning when they add the remote to the forked repo.  I modified the CONTRIBUTING documentation to include the appropriate command to run when adding the remote using HTTPS cloning.

Without this change, users who want to contribute to the project will not be able to follow the instructions outlined in the documentation, as an Access Denied error will occur when running git fetch if the remote is added using SSH agent forwarding.
@demdante demdante mentioned this issue Nov 19, 2020
Merged
flcdrg pushed a commit that referenced this issue Nov 19, 2020
@demdante @flcdrg
(GH-446) Updates documentation with important info
cea4aff 
In the current CONTRIBUTING documentation, the method documented for adding the remote assumes that the user is using ssh agent forwarding.  However, most users are going to be using HTTPS cloning when they add the remote to the forked repo.  I modified the CONTRIBUTING documentation to include the appropriate command to run when adding the remote using HTTPS cloning.

Without this change, users who want to contribute to the project will not be able to follow the instructions outlined in the documentation, as an Access Denied error will occur when running git fetch if the remote is added using SSH agent forwarding.
HolisticDeveloper pushed a commit to HolisticDeveloper/boxstarter that referenced this issue Oct 18, 2021
Merge branch 'master' of https://github.com/HolisticDeveloper/boxstarter
5f6559a 


* 'master' of https://github.com/HolisticDeveloper/boxstarter: (58 commits)
  Update chocolatey uninstall url
  Fix chocolatey links
  (chocolateyGH-446) Updates documentation with important info
  (chocolateyGH-443) Adds Windows Explorer item check box view Even though Boxstarter has existing functionality to modify Windows Explorer's settings, the existing functionality did not allow for user's to configure the "Use check boxes to select items" setting.  This commit adds that functionality to the existing set-windowsexploreroptions function.
  (chocolateyGH-451) more accurate regex
  (chocolateyGH-451) StopOnPackageFailiure not stripped without RebootCodes
  (release v2.13.0) Updated version numbers
  chocolateyGH-444 do not pass StopOnPackageFailure to choco
  Merge pull request from GHSA-rpgx-h675-r3jf
  (chocolateyGH-405) Fix package parameter handling (chocolatey#412)
  (chocolateyGH-434) Fix disabling bing search for Win release 2004+ (chocolatey#438)
  chocolateygh-435 docs for DelegateChocoSources
  (build) Replace direct usage of cinst
  (build) Pin all packages to specific version
  (build) Remove deprecated package
  (build) Make project files consistent
  (build) Pin to specific version of nuget.commandline
  (build) Remove VS import for web targets
  (build) Trying to fix AppVeyor build
  (doc) Update template
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0 - _Triaging Issue is accepted, but a milestone has yet to be added for the issue Documentation Issues for changes that only need to change documentation Improvement Issues that enhances existing functionality, or adds new features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-446) Updates documentation with important info demdante/boxstarter
2 participants
@pauby @demdante