Contribution Guidelines

[rahat2134]

General Guidelines ⚙️

• Align with Project Goals: Ensure your contribution is aligned with the overall goal of the project.
• Follow Code Style: Adhere to the existing code style for consistency. This includes variable names, indentation, and function structures.
• Ask Questions: If you are unsure about something, feel free to ask! We are happy to help and guide you.

How to Contribute 🚀

1. Fork the Repository: Create your own fork of the repository to make changes.
2. Create a New Branch: Name your branch based on the feature or fix you’re working on (e.g., feature/new-login or bugfix/fix-typo).
3. Make Changes: Implement the changes or fixes. Ensure your changes are properly tested and do not break existing features.
4. Run Tests: If applicable, run existing tests to make sure your changes don’t introduce new issues.
5. Open a Pull Request: Once you're confident in your changes, submit a pull request with a clear description of what you’ve done.

Code of Conduct 🧑‍🤝‍🧑

By participating in this project, you agree to abide by the following Code of Conduct:

• Be Respectful: Treat all contributors and maintainers with respect, kindness, and empathy, regardless of background or experience.
• Be Constructive: Provide thoughtful, constructive feedback. Help others grow through positive communication.
• Be Patient: Remember that contributors and maintainers might be balancing other tasks. Patience is appreciated.

✅ Do's

• Do write clear, descriptive commit messages.
  A good commit message should summarize what the change does, why it's being made, and any additional context if needed.

  • Example: Fixes issue with incorrect date format in the user profile.

• Do test your changes.
  Run tests and ensure your code does not break existing functionality.

• Do ask for help when needed.
  If you're uncertain about any aspect of the code or contribution process, ask! We’re happy to assist.

• Do ensure your code follows the repository’s coding standards.
  Stick to the same formatting and style used in the existing codebase.

🚫 Don’ts

• Don’t submit incomplete code or untested changes.
  Make sure your changes are fully implemented and tested before submitting a pull request.

• Don’t submit unrelated changes in the same pull request.
  Each PR should focus on one feature or bug fix. Keep things organized.

• Don’t raise duplicate issues.
  Before submitting a new issue, make sure to check the open issues to avoid duplicates.

Raising Issues 🛠️

When raising an issue, please follow these steps to make sure it's well-defined and easy to address:

1. Search Existing Issues: Before creating a new issue, check the existing issues to see if it has already been reported. If it has, add a comment to the existing issue instead of opening a new one.

2. Make the Title Clear and Concise:
   The title should immediately describe the problem or feature request in a few words.

3. Provide a Screen-Recorded Video (for UI-related issues):
   If your issue involves a visual bug or a UI-related problem, please provide a screen-recorded video showcasing the issue. This will help us understand the problem better.

4. Be Consistent with Code and UI/UX Styling:

   • Code Styling: Please follow the coding style that is already used in the repository. Refer to existing code to understand the structure and conventions.
   • UI/UX Styling: If you suggest changes to the user interface, ensure consistency with the existing design. For example, if the interface color scheme uses predominantly one color (e.g., green), avoid making arbitrary changes unless absolutely necessary.

5. Issue Assignment:

   • Do not request to be assigned multiple issues at once. Focus on one issue, and once your pull request (PR) is merged, you can request another issue.