From 9000cd2bee648598c8a86ba59a090f92f56907ca Mon Sep 17 00:00:00 2001 From: Megh Deb Date: Thu, 26 Dec 2024 08:16:41 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0519233 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Med-o-Next : Here Sickness Is A Myth + + + + + + + + + + + + + + + + + + + +
🌟 Stars🍴 ForksπŸ› IssuesπŸ”” Open PRsπŸ”• Close PRs
StarsForksIssuesOpen Pull RequestsClose Pull Requests
+ + +## πŸ‘¨β€πŸ’» Desired Contributions +- Implement new features or enhance existing functionality in the project. +- Fix bugs and issues reported in the repository. +- Optimize the performance of the application or specific components. +- Update or expand the project’s documentation to ensure clarity and completeness. +- Suggest and implement UI/UX improvements. +- Contribute ideas for future enhancements and roadmap items. + +## 🌿 Branching Guidelines +- **Main Branch**: The `main` branch should always be deployable and stable. Avoid direct commits. +- **Feature Branches**: Create feature branches for new features, using the format `feature/short-description` (e.g., `feature/add-login`). +- **Bugfix Branches**: Use `bugfix/short-description` for bug fixes (e.g., `bugfix/fix-auth-error`). +- **Hotfix Branches**: For critical fixes, use `hotfix/short-description` (e.g., `hotfix/fix-deployment-issue`). +- **Branch Scope**: Keep each branch focused on a single feature or fix to make reviews easier. + +## βœ… Pull Request Guidelines +- **Clear Titles**: Use descriptive titles for pull requests (e.g., `Fix user authentication flow` or `Add support for dark mode`). +- **Issue Reference**: Link the pull request to its corresponding issue (e.g., `Fixes #123`). +- **Commit Quality**: Ensure commits are clean and well-documented. Squash unnecessary commits before submitting. +- **Testing**: Test your changes thoroughly before creating a pull request. Include evidence (e.g., screenshots or logs) if applicable. +- **Review Readiness**: Ensure your branch is up-to-date with `main` and all conflicts are resolved. +- **Checklist**: + - Code follows project style guidelines. + - Added/updated documentation, if necessary. + - Added/updated tests for new or affected functionality. +- **Responsiveness**: Address feedback promptly during the review process. + +## Contributors + + + + + + +> [!IMPORTANT] +> ***Give a ⭐ to the repository before starting your contribution or raising an issue. Show some love or bhaichara πŸ«‚***