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 CONTRIBUTING.md for project #27562

Closed
captainsafia opened this issue Nov 5, 2020 · 6 comments
Closed

Update CONTRIBUTING.md for project #27562

captainsafia opened this issue Nov 5, 2020 · 6 comments
Labels
affected-medium This issue impacts approximately half of our customers area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework Docs This issue tracks updating documentation enhancement This issue represents an ask for new feature or an enhancement to an existing one severity-minor This label is used by an internal tool

Comments

@captainsafia
Copy link
Member

Update CONTRIBUTING.md docs to explain our CI process, how to address common feedback from the CI, and how we review PRs.

@captainsafia captainsafia added Docs This issue tracks updating documentation area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework labels Nov 5, 2020
@ShreyasJejurkar
Copy link
Contributor

Hi @captainsafia, I am also thinking to update BuildFromSource.md to get it more consistent like others. See workflow guide at other repositories. What I think is like they are more verbose and also at runtime repo they are having separate instruction on building various part of repo.
runtime - https://github.com/dotnet/runtime/blob/master/docs/workflow/README.md
Windows form - https://github.com/dotnet/winforms/blob/master/docs/developer-guide.md

@captainsafia
Copy link
Member Author

What I think is like they are more verbose and also at runtime repo they are having separate instruction on building various part of repo.

We are tackling this work as part of #27561.

I am also thinking to update BuildFromSource.md to get it more consistent like others.

We did some improvements on the BuildFromSource.md doc a while back. What kind of things should we copy from the runtime repo?

For now, this issue is focused on updating the CONTRIBUTING.md to address parts of the contribution process that aren't directly related to the build. If there's more improvements we can make in BuildFromSource.md we can track those in a different issue.

@wtgodbe wtgodbe added affected-medium This issue impacts approximately half of our customers enhancement This issue represents an ask for new feature or an enhancement to an existing one severity-minor This label is used by an internal tool labels Nov 12, 2020 — with ASP.NET Core Issue Ranking
@javiercn
Copy link
Member

@captainsafia is there anything left here you think we should consider?

@captainsafia
Copy link
Member Author

I'd like to refresh the changes introduced in #37362.

I think it would be helpful to bring up the PR during the next DoI meeting. I know @dougbu had some concerns about information loss but I wanted to avoid the doc being riddled with info that was too advanced.

@mkArtakMSFT
Copy link
Member

@captainsafia what is left to be done here, if anything? I think we should close it, if there is nothing specific, as I know you had done a lot of work a while ago on improving our docs.

@captainsafia
Copy link
Member Author

I think we can go ahead and close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affected-medium This issue impacts approximately half of our customers area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework Docs This issue tracks updating documentation enhancement This issue represents an ask for new feature or an enhancement to an existing one severity-minor This label is used by an internal tool
Projects
None yet
Development

No branches or pull requests

6 participants
@captainsafia @javiercn @wtgodbe @ShreyasJejurkar @mkArtakMSFT and others