Skip to content

Add issue templates, fixed readme - #8

Merged
elenagaljak-db merged 1 commit into
mainfrom
elenagaljak-db-readme_update
Oct 9, 2025
Merged

Add issue templates, fixed readme#8
elenagaljak-db merged 1 commit into
mainfrom
elenagaljak-db-readme_update

Conversation

@elenagaljak-db

Copy link
Copy Markdown
Collaborator

What changes are proposed in this pull request?

Provide the readers and reviewers with the information they need to understand
this PR in a comprehensive manner.

Specifically, try to answer the two following questions:

  • WHAT changes are being made in the PR? This should be a summary of the
    major changes to allow the reader to quickly understand the PR without having
    to look at the code.
  • WHY are these changes needed? This should provide the context that the
    reader might be missing. For example, were there any decisions behind the
    change that are not reflected in the code itself?

The “why part” is the most important of the two as it usually cannot be
inferred from the code itself. A well-written PR description will help future
developers (including your future self) to know how to interact and update your
code.

How is this tested?

Describe any tests you have done; especially if test tests are not part of
the unit tests (e.g. local tests).

ALWAYS ANSWER THIS QUESTION: Answer with "N/A" if tests are not applicable
to your PR (e.g. if the PR only modifies comments). Do not be afraid of
answering "Not tested" if the PR has not been tested. Being clear about what
has been done and not done provides important context to the reviewers.

@elenagaljak-db
elenagaljak-db marked this pull request as ready for review October 8, 2025 11:16
@teodordelibasic-db

Copy link
Copy Markdown
Collaborator

BTW I think you should remove all of the PR description template except the headings, so it should look like this:

## What changes are proposed in this pull request?

<YOUR TEXT>

## How is this tested?

<YOUR TEXT>

@elenagaljak-db
elenagaljak-db merged commit ec499d1 into main Oct 9, 2025
1 check passed
@elenagaljak-db
elenagaljak-db deleted the elenagaljak-db-readme_update branch October 9, 2025 09:10
pavledjuric-db pushed a commit that referenced this pull request Dec 15, 2025
@elenagaljak-db elenagaljak-db self-assigned this Jan 15, 2026
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.

2 participants