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.

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

Update Contribution Guide #3269

Merged
merged 23 commits into from
Nov 6, 2020
Merged

Update Contribution Guide #3269

merged 23 commits into from
Nov 6, 2020

Conversation

Kyaa-dost
Copy link
Contributor

Fixes #

Contribution Guide seems to be outdated and missing some info on troubleshooting regarding Issues, Features, PR, Docs etc.

PR Type

What kind of change does this PR introduce?

Documentation content changes

What is the current behavior?

Outdated Guide

What is the new behavior?

Updated Contribution Guide with steps on troubleshooting issues, features, PR's, WCTDocs etc

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs
  • Pull Request has been submitted to the documentation repository instructions. Link:
  • Sample in sample app has been added / updated (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Header has been added to all new source files (run build/UpdateHeaders.bat)
  • If new feature, add to Feature List
  • Contains NO breaking changes

Other information

Sorry, something went wrong.

@ghost
Copy link

ghost commented May 6, 2020

Thanks Kyaa-dost for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌

@ghost ghost assigned azchohfi May 6, 2020
contributing.md Outdated Show resolved Hide resolved
@michael-hawker
Copy link
Member

Actually wondering if we want to simplify this and then use the Wiki feature for all this developer/contributor-focused documentation like VS Code does here: https://github.com/Microsoft/vscode/wiki

See comment: #3318 (comment)

Thoughts? Let's discuss at our next toolkit meeting.

@michael-hawker
Copy link
Member

@Kyaa-dost now that we're moving this all to the wiki, should we just update this document to be more brief and point mainly to the wiki instead?

@michael-hawker michael-hawker marked this pull request as draft October 8, 2020 20:09
@Kyaa-dost Kyaa-dost marked this pull request as ready for review October 30, 2020 21:35
contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
contributing.md Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Hawker MSFT (XAML Llama) <[email protected]>
@ghost
Copy link

ghost commented Nov 3, 2020

This PR has been marked as "needs attention 👋" and awaiting a response from the team.

readme.md Outdated

# Windows Community Toolkit
# Windows Community Toolkit :briefcase:
Copy link
Member

Choose a reason for hiding this comment

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

We may want to the toolbox emoji 🧰 or our own logo maybe from our design assets?

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@ghost
Copy link

ghost commented Nov 5, 2020

This PR has been marked as "needs attention 👋" and awaiting a response from the team.

readme.md Outdated
## NuGet Packages
NuGet is a standard package manager for .NET applications which is built into Visual Studio. To open the UI, from your open solution, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution...* . Enter one of the package names below to search for it online.
## NuGet Packages :package:
NuGet is a standard package manager for .NET applications which is built into Visual Studio. From your open solution, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution...* Enter one of the package names mentioned in [Windows Community Toolkit Nuget Packages](https://docs.microsoft.com/en-us/windows/communitytoolkit/nuget-packages) table to search for it online.
Copy link
Contributor

Choose a reason for hiding this comment

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

It feels wordy and seems like it lacks context. We just tell them how to get the packages with out saying "To get our nuget packages...".

Maybe instead of telling the user how to install NuGet our packages, we should let them know our NuGet package IDs. Or just link to the project wiki and list the IDs there. From what I understand how to get NuGet packages from nuget.org is a fairly common knolege in the community. Also how to obtain nuget packages depends on your eviorment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The description is mirroring the Nuget Package page. I can work on the proper wording.

At this point, they are just setting up and people come from all different backgrounds so I am not certain if we need this much detail here in the readme. I am not certain about the ID's. Perhaps if you want to create a list in the wiki and then we can see if we can link that in the readme?

Copy link
Contributor

@Rosuavio Rosuavio Nov 6, 2020

Choose a reason for hiding this comment

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

O I am not saying to copy that page in the readme. Just maybe keep it shorter and not try to explain to the users how to install the packages. Most users will probably just want the package IDs, which would clutter the readme. Maybe making it more succinct and leave the rest to the Nuget Package page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just fixed the wording for steps. It is already concise enough as this is all the information they need and the whole focus of this readme is to provide a glimpse of the information on steps and redirect it to the NuGet package.

If you have a suggestion, create a commit suggestion and we can review if that's what we want in the content 😊

Copy link
Member

Choose a reason for hiding this comment

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

Want to get the rest updated, @RosarioPulella feel free to submit a follow-on PR with any suggestions for changes.

contributing.md Outdated Show resolved Hide resolved
@michael-hawker
Copy link
Member

Going to merge this in now so we can get the link to MyGet off the readme and finish that transition.

@Kyaa-dost
Copy link
Contributor Author

Going to merge this in now so we can get the link to MyGet off the readme and finish that transition.

Yayyyyyy Lets do it 🚀 🚀

@michael-hawker michael-hawker merged commit 75753e5 into master Nov 6, 2020
@delete-merged-branch delete-merged-branch bot deleted the Contribution-guide branch November 6, 2020 21:18
@michael-hawker michael-hawker added this to the 7.0 milestone Nov 6, 2020
@ghost ghost added the Completed 🔥 label Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants