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

docs(open-source): EX-4666 GitHub specific documentation #136

Merged
merged 53 commits into from Sep 15, 2021

Conversation

lydiafp
Copy link
Contributor

@lydiafp lydiafp commented Sep 6, 2021

Pull Request Template

Review all GitHub specific documentation in the open source project.

Motivation and Context

As part of the open source initiative, all GitHub specific documentation such as contributing guidelines, naming conventions and issue templates have been reviewed for clarity and consistency.

Bug & feature templates have been converted to YAML format to create a user friendly form. If the new format is accepted, existing template MD files must be deleted in order for GitHub to use the new format as a template. Any MD files in the ISSUE TEMPLATE folder takes precedence.

Type of change

  • This change requires a documentation update

What is the destination branch of this PR?

Main

How Has This Been Tested?

Checklist:

  • [N/A] My code follows the style guidelines of this project
  • [N/A] I have performed a self-review of my own code
  • [N/A] I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • [N/A] I have added tests that prove my fix is effective or that my feature works
  • [N/A] New and existing unit tests pass locally with my changes

Copy link
Contributor

@herrardo herrardo left a comment

Choose a reason for hiding this comment

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

Congratulations on your work Lydia!!

I have left some comments

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
.github/contributing/components.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
herrardo
herrardo previously approved these changes Sep 8, 2021
@herrardo herrardo requested a review from a team September 10, 2021 11:58
.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
.github/contributing/base-naming.md Outdated Show resolved Hide resolved
.github/contributing/commits.md Outdated Show resolved Hide resolved
.github/contributing/commits.md Outdated Show resolved Hide resolved
.github/contributing/commits.md Outdated Show resolved Hide resolved
.github/contributing/components.md Outdated Show resolved Hide resolved
.github/contributing/components.md Outdated Show resolved Hide resolved
.github/contributing/components.md Outdated Show resolved Hide resolved
.github/contributing/components.md Outdated Show resolved Hide resolved
.github/contributing/commits.md Outdated Show resolved Hide resolved
CachedaCodes
CachedaCodes previously approved these changes Sep 14, 2021
herrardo
herrardo previously approved these changes Sep 14, 2021
@herrardo
Copy link
Contributor

@lydiafp, I think you could delete the .md version of the templates to start using the .yaml in this PR, could you do that and we approve again?

cc @CachedaCodes

@lydiafp lydiafp dismissed stale reviews from herrardo and CachedaCodes via 6d7fe56 September 14, 2021 11:28
herrardo
herrardo previously approved these changes Sep 14, 2021
@herrardo herrardo dismissed their stale review September 14, 2021 12:19

found links to update

herrardo
herrardo previously approved these changes Sep 14, 2021
CachedaCodes
CachedaCodes previously approved these changes Sep 14, 2021
@CachedaCodes CachedaCodes dismissed stale reviews from herrardo and themself via d1090af September 14, 2021 13:45
@CachedaCodes CachedaCodes merged commit b58f751 into main Sep 15, 2021
@CachedaCodes CachedaCodes deleted the docs-x-opensource branch September 15, 2021 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants