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

Merge Dev to SCD-38 #23

Merged
merged 12 commits into from
Mar 21, 2023
Merged

Merge Dev to SCD-38 #23

merged 12 commits into from
Mar 21, 2023

Conversation

sleepy0owl
Copy link
Member

@sleepy0owl sleepy0owl commented Mar 21, 2023

👮 Pull Request Checklist

📝 Description

  • This PR contains the code to create a PR checklist that will help the team in identifying a few common points that needs to be checked while raising a PR.

🎫 Associated JIRA tickets

  • SCD-18
    • A screenshot followed by the description of the ticket. This ticket deals with creating a common PR checklist template which will be improved continuously to help the developer.
    • Any additional information for testing the ticket.

⚔️ Mandatory Checks

  • Is the functionality working as expected?
  • Are the comments are clear and useful, and mostly explain why instead of what?
  • Does it match the required coding standards?
  • Is the performance up to the mark?

🛠️ Regular Checks

  • Spell Checks.

🗡️ Optional Checks

  • Schema Changes

🤳 PR Self-Review

  • DRY: Don't repeat yourself
  • YAGNI: You aren't gonna need it. Make sure you're not over-complicating something just to try & make it more future-proof 🙅‍♂️
    • P.S. According to Fowler, "Yagni only applies to capabilities built into the software to support a presumptive feature, it does not apply to effort to make the software easier to modify."
  • A link to some of the best practices for creating a PR

⚠️ Wait for PR status checks to complete before approving PR

@github-advanced-security
Copy link

You have successfully added a new SonarCloud configuration ``. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

@sleepy0owl sleepy0owl merged commit c071163 into SCD-38 Mar 21, 2023
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