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

Add pull request and issue templates #222

Merged
merged 1 commit into from
Jun 20, 2023
Merged

Add pull request and issue templates #222

merged 1 commit into from
Jun 20, 2023

Conversation

aroramrinaal
Copy link

@aroramrinaal aroramrinaal commented Jun 19, 2023

Description:

This pull request adds pull request (PR) and issue templates to improve the contribution process and communication within the project. The PR template provides a structure for clear submissions, while the issue template helps in creating well-structured reports. These templates ensure consistency, improve communication, and streamline the process.

I have created the following templates:

Pull Request Template: Link to the PR template file
Issue Template: Link to the issue template file

Fixes: #84

@patillacode
Copy link
Collaborator

I think this will enhance the experience of going through issues, thanks @aroramrinaal

Since this is a change that affects how the project is presented to the users/contributors I'll wait for someone else to merge, but I have approved it.

Maybe @AntonOsika wants to re-word something or get rid a check or two.

cc @carlthome @FOLLGAD

@carlthome
Copy link
Contributor

Personally hesitant to introduce heavy templates, and prefer a polished CI over requiring manual steps by humans.

Would be funny if this repo started not only self-hosting with gpt-engineer but also if it auto-reviewed PRs with LLMs as well.

@patillacode
Copy link
Collaborator

We maybe don't need templates or at least not as heavy but I definitely think we would benefit from an issues template even if minimal.

I am down for CI steps but there are no CI steps that can help the user properly explain an issue!

@AntonOsika
Copy link
Owner

Great initiative.

And yes: we should definitely set up LLM reviews! Any ideas on which ones @carlthome?

Also I agree that it's a good idea to see if we can make it faster to fill in the templates by simplifying. Or even say that you can adapt the template to your liking.

What do you think @aroramrinaal, anything you think is not "crucial" to include?

@AntonOsika AntonOsika merged commit b7aa483 into AntonOsika:main Jun 20, 2023
@patillacode
Copy link
Collaborator

Hey @AntonOsika

Templates don't seem to be properly applied, I don't have access to the settings of the repo, so it needs to be you.
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

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.

Proposal: Adding PR and Issue Templates
4 participants