-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Med-o-Next : Here Sickness Is A Myth | ||
<table align="center"> | ||
<thead align="center"> | ||
<tr border="2px"> | ||
<td><b>🌟 Stars</b></td> | ||
<td><b>🍴 Forks</b></td> | ||
<td><b>🐛 Issues</b></td> | ||
<td><b>🔔 Open PRs</b></td> | ||
<td><b>🔕 Close PRs</b></td> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><img alt="Stars" src="https://img.shields.io/github/stars/Megh2005/Med-o-Next-TJP?style=flat&logo=github"/></td> | ||
<td><img alt="Forks" src="https://img.shields.io/github/forks/Megh2005/Med-o-Next-TJP?style=flat&logo=github"/></td> | ||
<td><img alt="Issues" src="https://img.shields.io/github/issues/Megh2005/Med-o-Next-TJP?style=flat&logo=github"/></td> | ||
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/Megh2005/Med-o-Next-TJP?style=flat&logo=github"/></td> | ||
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/Megh2005/Med-o-Next-TJP?style=flat&color=critical&logo=github"/></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
|
||
## 👨💻 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 | ||
<a href="https://github.com/Megh2005/Med-o-Next-TJP/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=Megh2005/Med-o-Next-TJP" /> | ||
</a> | ||
|
||
|
||
|
||
> [!IMPORTANT] | ||
> ***Give a ⭐ to the repository before starting your contribution or raising an issue. Show some love or bhaichara 🫂*** |