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

Create a Pull Request Template #2960

Closed
lock9 opened this issue Nov 10, 2023 · 4 comments · Fixed by #3081
Closed

Create a Pull Request Template #2960

lock9 opened this issue Nov 10, 2023 · 4 comments · Fixed by #3081
Assignees
Labels
Design Issue state - Feature accepted but the solution requires a design before being implemented Discussion Initial issue state - proposed but not yet accepted

Comments

@lock9
Copy link
Contributor

lock9 commented Nov 10, 2023

Summary or problem description
We must ensure that PRs clearly describe the problem being solved and the solution.
Related: #2955

Do you have any solution you want to propose?
Use a PR template to ensure PRs have the required information before being evaluated by the team.

@lock9 lock9 added the Discussion Initial issue state - proposed but not yet accepted label Nov 10, 2023
@Jim8y
Copy link
Contributor

Jim8y commented Nov 11, 2023

please take a look at the draft. we have suspended adding new prs before we create the monorepo, but we can discuss it here:

# Pull Request Template

## Problem Statement
<!-- Briefly describe the problem this PR is aiming to solve. -->

## Solution Description
<!-- Clearly and concisely describe the solution you're proposing. -->

## Dependencies
<!-- List any PRs or external factors this PR depends on, if any. -->

## Impact on the Ecosystem
<!-- Discuss how this PR will affect the broader ecosystem. Will it require changes from other developers? -->

## Instructions for Reviewers
<!-- Provide any special instructions or things reviewers should keep in mind while reviewing the code. -->

### Testing Guidelines
<!-- If applicable, provide guidelines on how to test the changes made by this PR. -->

### Checklist
<!-- Reviewers can use this section as a checklist while reviewing the PR. -->
- [ ] Code follows project's coding standards
- [ ] Proper comments/documentation included
- [ ] Impact on the ecosystem is clearly understood and documented
- [ ] All tests pass (if applicable)

## Additional Notes
<!-- Include any additional information that might be helpful for reviewers or future references. -->

## Screenshots or Demo (if applicable)
<!-- If your changes have a visual component or affect the UI, include screenshots or a short demo video. -->

@Jim8y Jim8y added the Design Issue state - Feature accepted but the solution requires a design before being implemented label Nov 11, 2023
@cschuchardt88
Copy link
Member

cschuchardt88 commented Nov 11, 2023

  • Code follows project's coding standards

We should also update .editorconfig to help with these code standards. That's what the file is for. Copy and pasting the File header for example is annoying. In neo-express we are using https://github.com/neo-project/neo-express/blob/master/.editorconfig

@roman-khimov
Copy link
Contributor

It can be an org-wide template, btw. Just needs to be placed into .github repo.

@Jim8y
Copy link
Contributor

Jim8y commented Nov 12, 2023

It can be an org-wide template, btw. Just needs to be placed into .github repo.

Yep, i think @roman-khimov can add them directly when you create the monorepo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design Issue state - Feature accepted but the solution requires a design before being implemented Discussion Initial issue state - proposed but not yet accepted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants