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

Update CONTRIBUTING.md and add Issue, PR templates #326

Merged
merged 2 commits into from
Apr 11, 2023

Conversation

terryyylim
Copy link
Collaborator

This PR adds 2 issue templates, specifically for feature request and bug reporting, and CONTRIBUTING.md file has been updated to reflect these changes.

The goal is to better streamline our OSS processes so that community users can better interact with us.

@terryyylim terryyylim added the type: documentation Improvements or additions to documentation label Mar 28, 2023
@terryyylim terryyylim self-assigned this Mar 28, 2023
@terryyylim terryyylim requested a review from a team March 28, 2023 04:47
Copy link
Collaborator

@krithika369 krithika369 left a comment

Choose a reason for hiding this comment

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

Should we, at some point, also have the some labelling of the PR (example) and link to the release notes generation?

description: What Turing component is this issue related to?
multiple: true
options:
- Core
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we separate this into API and Router?

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line seems redundant with the previous.

CONTRIBUTING.md Show resolved Hide resolved
Copy link
Collaborator

@krithika369 krithika369 left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @terryyylim !

@terryyylim terryyylim changed the title Update CONTRIBUTING.md and add issue templates Update CONTRIBUTING.md and add Issue, PR templates Apr 11, 2023
@terryyylim terryyylim merged commit 4889ff3 into caraml-dev:main Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants