How to write Issue & PR

[GarimaSingh0109]

Writing an Issue
An issue is a way to track bugs, enhancements, or tasks within a project. Here’s how to create a well-structured issue:

Title:

Write a concise and descriptive title.
Example: Login page does not validate special characters
Description:

Clearly describe the issue or request. Include:

1. Context: Explain the background of the issue.
2. Steps to Reproduce: Provide step-by-step instructions to reproduce the issue, if applicable.
3. Expected Behavior: Describe what you expected to happen.
4. Actual Behavior: Describe what actually happened.
5. Screenshots/Logs: Attach any relevant screenshots or logs that illustrate the issue.

---

Writing a Pull Request (PR)
A pull request is a request to merge code changes from one branch into another, typically from a feature branch into the main branch. Here’s how to write a clear and effective PR:

Title:

• Use a descriptive title that summarizes the changes.
  Example: Fix issue with user authentication on login
  Description:
• Provide a detailed explanation of what the PR does. Include:

1. Purpose: Why is this change being made?
2. Changes: Briefly list the changes or features added.
3. Related Issues: Reference any related issues using keywords (e.g., Fixes feat :Add basic hover animation to Navbar  #123).
4. Testing: Explain how the changes were tested.
5. Screenshots: If applicable, include before-and-after screenshots or examples.