Skip to content

Commit

Permalink
Update pull_request_template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vishakh-abhayan authored Aug 19, 2024
1 parent 1689697 commit b4d3b97
Showing 1 changed file with 25 additions and 85 deletions.
110 changes: 25 additions & 85 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,39 @@
# Pull Request: Evaluation Criteria for Stage 3
**Pull Request Title:** [Your MUID]

## Introduction
This pull request proposes a new set of evaluation criteria for Stage 3, focusing on advanced aspects of software development. These criteria are designed to assess and foster innovation, community engagement, effective feedback reception, collaboration, domain-specific knowledge, and system design skills.
### Help or Support

## Evaluation Criteria
Please review the following proposed criteria and check each box to indicate your review and agreement:
If you continue to face any challenges or have further questions, we're here to help! Additionally, you can join our Top 100 Support WhatsApp Group for real-time assistance. Just click on the link:
[join group](https://chat.whatsapp.com/CSnvfSvv06eB1j9GEKavRn)

```
## Checklist:
Before you submit this pull request, please ensure you have completed the following items.
### Profile Highlights

### Attitude and Values
- [ ] Feedback Reception: Openness to receiving feedback and making necessary improvements.
- [ ] Innovation: Attitude of thinking outside the box, coming up with novel solutions or approaches to problems.
Please make sure to complete the following profile highlights by checking the boxes. This helps us learn more about you and your coding journey.

### Abilities and Skills
- [ ] Collaboration: Skill in working within a team, understanding team dynamics, and contributing effectively.
- [ ] Leadership and Influence:
- [ ] Networking:
- [ ] As a Top 100 Member:
- [ ] Career Plan:
- [ ] Thoughts on Kerala's Tech Ecosystem:
- [ ] History of Open Source Contributions:
- [ ] History of Community Engagement:
- [ ] Highly Visible Technical Content:
- [ ] Highly Used Software Tools:
- [ ] Competitive Website Profiles:

### Knowledge and Information
- [ ] Domain-Specific Knowledge: Depending on the challenge, knowledge in areas like AI/ML,Becken, blockchain, game development, etc.
- [ ] System Design: Understanding of how to design scalable and efficient systems, including databases, servers, and client interactions.

### Other Criteria
- [ ] Has open source contributions
### Additional Information

### Do you vouch for the top 100 coders?
- [ ] I vouch. You belong to the lead of Top 100 Coders 2023
- [ ] Good Job, All the best for the Top 100 Coders 2024
```
If you have any additional information or comments you'd like to include, please feel free to add them here.

## Code Evaluation Criteria

```

### Decisions - Pre Coding
- [ ] Did they have a pre-planning involved, with discussions about the complexities involved and how to solve?
- [ ] Can they reason their choice for selecting the tech stack used?
### Checklist

### Quality and Organization of Code
- [ ] Is the code clean, readable, well-organized and maintainable?
- [ ] Does the variable and function names make sense?
- [ ] Does the code adhere to best practices and standards? (structure, formatting, etc.)
- [ ] Are development best practices such as branching, merging, and pull requests well-utilized?
- [ ] Does the commit messages make sense?
Before submitting this PR, please ensure that you have:

### Authentication & Sanitization
- [ ] Does the project have a viable and secure authentication system in place?
- [ ] Are request parameters from the user sanitized before processing?
- [ ] Checked all the relevant boxes above.
- [ ] Named your file using your MUID (e.g., `your-muid.md`).
- [ ] Followed the provided template for each section.
- [ ] Make sure you joined the Whatsapp Group

### Error Handling
- [ ] Are the errors rescued and handled well?
- [ ] Do they have an error monitoring in place?
- [ ] For the user, are the errors conveyed in a senseful manner?
### Working as a team
- [ ] Do the pull requests have apt title and description? Can the reviewer / team mate draw enough context from the pull request description?
- [ ] Are the pull requests slim? i.e, not bloated, no unrelated changes in the same PR? Is the PR easy to review?
- [ ] Did they have a good mode of communication? How often were the communication between the team?
- [ ] Did they have documentation / scratch pads / brainstorming sessions with the team for features while building?
### Database
- [ ] Does the project have a DB schema?
- [ ] Can they reason why they chose this database?
- [ ] Are adequate database validations in place? (Uniqueness or presence of emails for users etc.)
- [ ] If the database is hosted, how is the connection to the database established? Is it from inside a secure network?
### Scalability, Performance and Security Considerations
- [ ] Can the solution scale effectively?
- [ ] Is the solution well-prepared for external API related issues (timeouts, rate limiting, errors)?
- [ ] Does the project adequately address security and data management practices, particularly in relation to data handling and storage?
- [ ] How are the tokens managed? Are any tokens exposed on client side or being committed into code?
### Overall Technical Excellence
- [ ] Overall, does the technical aspect of the project and the coder stand out?
### Additional Feedback for Developers
> Please provide any additional feedback or observations
### Do you vouch for the top 100 coders?
- [ ] I vouch. You belong to the lead of Top 100 Coders 2023
- [ ] Good Job, All the best for the Top 100 Coders 2024
```


## Purpose
The purpose of these criteria is to provide a comprehensive and structured approach to evaluating advanced skills and contributions in software development, ensuring continuous improvement and excellence.

## How to Use
These criteria can be used for performance reviews, peer feedback, and self-assessment in advanced stages of software development roles.





---

Please review the proposed evaluation criteria for Stage 3 and check the corresponding boxes to indicate your review status, feedback, or approval. Your input is invaluable to ensure the criteria are robust and effective.
Thank you for participating in Kerala Top 100 Coders - Huddle Global 2023!

0 comments on commit b4d3b97

Please sign in to comment.