Skip to content

Need for Pull Request template #41

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

Closed
technoph1le opened this issue Dec 30, 2024 · 7 comments
Closed

Need for Pull Request template #41

technoph1le opened this issue Dec 30, 2024 · 7 comments
Labels
discuss Needs to be discussed by community enhancement New feature or request

Comments

@technoph1le
Copy link
Owner

We need to make a simple pull request template for our contributors. It would make so much easier for our maintainers to review and debug problems as well.

I would love to hear some ideas on what to include and how to format the template, so it's easy to understand and don't overwhelm new/first-time contributors at the same time.

@technoph1le technoph1le added enhancement New feature or request discuss Needs to be discussed by community labels Dec 30, 2024
@Mathys-Gasnier
Copy link
Collaborator

We also need to inform them about not modifying the all_snippets.json file xD

@Mathys-Gasnier
Copy link
Collaborator

We should also have a convention for naming pull requests, i was thinking something along those line:
[Type] Name

So if for example we are modifying something in the css:
[CSS] Updating thing
And if we are adding, removing or updating a snippet:
[Snippet/Language] Name

@GreenMan36
Copy link
Contributor

Something loosely along the lines of;

# Description

<!-- Please include a summary of your changes. -->

## Type of Change

<!-- Please delete options that are not relevant and check the appropriate boxes. -->

- [ ] New snippet(s)
- [ ] Improvement to existing snippet(s)
- [ ] Bug fix
- [ ] Documentation update
- [ ] Other (please describe):

## Checklist

<!-- Please check all items that apply using "x" -->

- [ ] I have tested all submitted code snippets and verified they work as intended
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code appropriately where needed
- [ ] I have updated the documentation accordingly (if applicable)
- [ ] My changes generate no new warnings
- [ ] For new snippets:
  - [ ] I have added appropriate tags
  - [ ] I have included a clear description
  - [ ] The category is appropriate (or I have created a new one)
  - [ ] Code is properly formatted and commented

## Related Issues

<!-- Please link to any related issues here using the GitHub syntax: #issue-number -->

Closes #

## Additional Context

<!-- Add any other context about the pull request here. -->

## Screenshots

<!-- If you made visual changes other than snippets, add screenshots to help explain your changes. -->

<details>
<summary>Screenshots</summary>

<!-- Paste your screenshots here -->

</details>

?

@Mathys-Gasnier
Copy link
Collaborator

That looks really good ! Thanks for the work on that front

@Mathys-Gasnier
Copy link
Collaborator

One other thing I would like, and i'm probably not alone on this... When adding a new language, even if the PR also adds some snippet, it should add the Hello World! snippet for that language

@technoph1le
Copy link
Owner Author

I just found that FreeCdoeCamp has done a really good job in creating issue templates:

GitHub issue templates preview

A great place to take inspirations.

@technoph1le
Copy link
Owner Author

Now, we have a pull request template as well. Here's the first preview:

Pull request template in use

Commit solved this issue: 1d08bb2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Needs to be discussed by community enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants