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

chore(github): Update GitHub Pull Request Template #1370

Merged
merged 3 commits into from
May 23, 2023
Merged

chore(github): Update GitHub Pull Request Template #1370

merged 3 commits into from
May 23, 2023

Conversation

Savio-Sou
Copy link
Collaborator

Description

Summary of changes

Updating the PR template:

  • Remove "Dependency additions / changes" and "Test additions / changes" sections, which should be covered in the "Summary" section
  • Add "Example" section
  • Add followup options when PR requires documentation updates
  • Trim checklist
  • Minor word & formatting changes

Demo PR: noir-lang-test#12

Checklist

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt with default settings.
  • I have linked this PR to the issue(s) that it resolves.
  • I have reviewed the changes on GitHub, line by line.
  • I have ensured all changes are covered in the description.

Additional context

Once this is merged, I'll create a PR to update the template in noir-lang/.github accordingly.

@Savio-Sou Savio-Sou mentioned this pull request May 22, 2023
Merged
5 tasks
TomAFrench
TomAFrench reviewed May 22, 2023
View reviewed changes
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

I think the step by step examples section may not be applicable for a lot of PRs. I would just have it as a comment under Summary to add examples if appropriate.

@Savio-Sou Savio-Sou requested a review from TomAFrench May 23, 2023 05:07
@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented May 23, 2023 •
edited
Loading

Made the Example section:

  • Optional
  • A sub-section of Summary

instead of as a comment to ease the use of it when applicable.

@TomAFrench TomAFrench added this pull request to the merge queue May 23, 2023
Merged via the queue into master with commit 66744f3 May 23, 2023
@TomAFrench TomAFrench deleted the ss-pr-template branch May 23, 2023 08:31
TomAFrench added a commit that referenced this pull request May 24, 2023
@TomAFrench
Merge branch 'master' into phated/acvm-0.12.0
09db55c 
* master:
  chore(ssa refactor): Add loop unrolling pass (#1364)
  chore: Add terms added in ssa refactor to `cspell` (#1385)
  chore(ssa refactor): Optimize constant `jmpif`s into `jmp`s (#1374)
  feat: Allow warnings by default (#1383)
  chore(github): Update GitHub Pull Request Template (#1370)
  chore(github): Update GitHub Bug Report Template (#1368)
  chore(ssa refactor): Update mem2reg pass to work with multiple functions and blocks (#1375)
  chore(ssa refactor): Add pass to simplify the control flow graph (#1373)
  chore(github): Update GitHub Feature Request Template (#1369)
@Savio-Sou Savio-Sou mentioned this pull request May 29, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAFrench TomAFrench TomAFrench approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Savio-Sou @TomAFrench