MedPlant is an open-source project focused on creating awareness of the medicinal properties of various plants.
It aims to provide a comprehensive resource for individuals interested in alternative medicine, herbal remedies, and the healing potential of plants.
If you have any kind of doubts or queries do not hesitate to contact me. Please place "😎😎😎" emojis in your subject of email, so that I can easily be attentive to your mail or query.
- Extensive database of plant profiles with detailed information about their medicinal properties.
- Community-driven platform for sharing research findings, experiences, and insights related to plant-based medicine.
-
Clone this repository.
-
Run the application.
We welcome contributions from the open-source community to improve MedPlant. To contribute, please follow these guidelines:
- Fork the repository and create a new branch for your contribution.
- Ensure that your code adheres to the project's coding style and guidelines.
- If you're introducing new features, enhancements, or fixes, please write clean and well-documented code.
- Test your changes thoroughly to ensure they do not introduce any regressions.
- Submit a pull request with a clear description of the changes, the problem it solves, and any relevant details.Please have a look at resources on how to get a pull request.
We encourage contributors to add new plant profiles to expand the knowledge base. To maintain consistency and quality, please consider the following guidelines:
- Check the existing plant profiles to ensure that the plant you wish to add hasn't been covered already.
- Use the existing plant profiles as a reference to understand the required information and formatting.
- Write an informative and well-researched plant profile, including details about its medicinal properties, cultivation methods, traditional uses, and any relevant scientific research.
- Ensure that the information provided is accurate, reliable, and properly cited if necessary.
- Include relevant images or diagrams to enhance the understanding of the plant profile.
- Proofread the plant profile for grammar, spelling, and readability before submitting.
If you encounter any issues or have suggestions for improvements, please follow these steps:
- Check the existing issues to see if the problem has already been reported.
- If it hasn't been reported, create a new issue with a clear and descriptive title.
- Provide detailed steps to reproduce the issue and any relevant information about your environment.
- If possible, include screenshots or error messages related to the issue.
- Assign appropriate labels to the issue (e.g., bug, enhancement, documentation).
Improvements to documentation are always welcome! If you find any areas that can be clarified, expanded, or corrected, please feel free to contribute. Here's how you can help:
- Review the existing documentation and identify areas for improvement.
- If you're suggesting new documentation, create a new markdown file in the appropriate directory.
- Make sure your documentation follows the same style and format as the existing documentation.
- Submit a pull request with the changes and provide a brief explanation of the updates made.
For a better understanding of the project, we recommend watching the following video:
This video provides insights into the how to push a change to our repo.
To make changes to the code, please follow these guidelines:
- Create a new branch for your changes, preferably named after the specific feature or bug you're working on.
- Make your changes on the separate branch.
- Test your changes thoroughly.
- Once you're confident in your changes, submit a pull request to merge your branch into the main branch.
All the contributors for this project can include their name in the AUTHORS file.
MedPlant is open-source and released under the MIT License.
If you have any questions, suggestions, or feedback, please reach out to us at: jyothiswarupseethala8086@gmail.com.
We would like to express our gratitude to all contributors who have helped shape and improve MedPlant.
Your contributions are greatly appreciated!