From 29a2a6da6b55c649dd8411bbf5846ba002d739ff Mon Sep 17 00:00:00 2001 From: Nikhil More <149102391+Nikhil0-3@users.noreply.github.com> Date: Sat, 26 Oct 2024 17:01:10 +0530 Subject: [PATCH] Create Contributing.md --- Contributing.md | 186 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..fb44bd5 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,186 @@ +# πŸ›€οΈ **SereniFi Contribution Guide** 🌍 + +Thank you for your interest in contributing to **SereniFi** – your go-to app for mental tranquility! Whether you're helping users unwind with guided meditations πŸ§˜β€β™‚οΈ, enhance focus with breathing exercises 🌬️, or enjoy soothing music 🎢, we’re excited to have you onboard! + +This project has been **OFFICIALLY accepted** for **GSSoC 2024 Extended** and **Hacktoberfest 2024**, making it a perfect opportunity for you to contribute to an exciting open-source project! πŸš€ + +--- + +## 🌟 **Project Stats** + +- **⭐ Stars**: [stars count] +- **🍴 Forks**: [forks count] +- **πŸ› Issues**: [issues count] +- **πŸ”” Open Pull Requests**: [open PRs count] +- **πŸ”• Closed Pull Requests**: [closed PRs count] +- **πŸ› οΈ Languages Used**: [language count] +- **🌐 Contributors**: [contributors count] + +--- + +## πŸš€ **How to Get Started** + +Follow these steps to get started with contributing to **SereniFi**: + +1. **Fork this Repository** 🍴: + Click the fork button at the top of the repository page to create a copy in your GitHub account. + +2. **Clone the Repository to Your Local Machine** 🧩: + Open your terminal and clone the repo: + ```bash + git clone https://github.com/Your-Username/serenity-guide.git + + ``` +3. **Create a New Branch 🌿:** Work on a separate branch for your feature or fix: + +```bash + +git checkout -b "Feature-Name" +``` +4. **Make Your Changes πŸ› οΈ:** Add your code, test it locally, and ensure everything works. + +5. ** Add and Commit Your Changes πŸ’¬:** Save your progress and commit with a meaningful message: + +```bash +git commit -m "Brief Description of Changes" +``` +6. **Push Your Changes 🚒:** Push your feature branch to your remote repository: + +```bash + +git push origin Feature-Name +``` +7. **Submit a Pull Request πŸ”₯:** Go to GitHub and create a Pull Request (PR) for review. + +## πŸŽ‰ Welcome, Contributors! πŸ‘‹ +We are excited to have you contribute to SereniFi! Whether it's a bug fix, feature addition, or enhancing documentation, we welcome all contributions. + +Here’s how you can start contributing: + +- Fork the Repository: Click the Fork button at the top of the repo. +- Create a New Feature Branch: Always work on a new branch for your changes. +- Make Meaningful Commits: Commit your changes with descriptive messages. +- Push to the Branch: Push your local branch to GitHub. +- Open a Pull Request (PR): Submit your PR for review. +We’re looking forward to your contributions, big or small! + +## πŸ”§ Contribution Guidelines +To ensure the quality of contributions to SereniFi, please adhere to the following guidelines: + +1.**Code Style:** +- Maintain consistent code formatting and style as seen in the project. +- Write clean and readable code. +- Comment your code where necessary to explain complex logic. + +2. **Commit Messages:** +- Write clear, meaningful commit messages. +- Use a brief description that clearly states the purpose of the change. + +3. **Pull Requests:** +- PRs should be focused on solving a specific issue or implementing a single feature. +- Make sure the PR is well-explained and links to any relevant issues. + +4. **Testing:** +- Ensure that your changes are thoroughly tested and do not break existing functionality. +- Test your code locally before pushing to GitHub. + +5. **Issue Tracker:** +- Review open issues before starting a new feature or fix. +- Reference related issues in your PRs. + +## πŸ› οΈ Technologies We Use +SereniFi is built with the following technologies: + +- Python: Backend logic and server-side operations. +- Streamlit: For building and deploying the web app. +- HTML/CSS: For structuring and styling the user interface. +- JavaScript: For interactive elements on the front end. +- APIs: For accessing additional resources (e.g., music, meditation). + +## πŸ“‚ Enhanced Project Structure +This section provides an organized layout of the SereniFi repository, helping you easily navigate the codebase. + +```bash + +β”‚ +β”œβ”€β”€ .devcontainer +β”‚ └── devcontainer.json # Configuration for the development container +β”‚ +β”œβ”€β”€ .github +β”‚ β”œβ”€β”€ ISSUE_TEMPLATE # Directory for issue templates +β”‚ β”‚ β”œβ”€β”€ bug_report.yml # Template for reporting bugs +β”‚ β”‚ └── feature_request.yml # Template for requesting features +β”‚ β”‚ +β”‚ └── workflows # Directory for GitHub Actions workflows +β”‚ β”œβ”€β”€ check-up-to-date.yml # Workflow to check if dependencies are up to date +β”‚ β”œβ”€β”€ check_screenshot.yml # Workflow to verify screenshots/UI +β”‚ └── greetings.yml # Configuration for automated greeting messages +β”‚ +β”œβ”€β”€ .gitignore # Specifies files/folders to ignore by Git +β”‚ +β”œβ”€β”€ CODE_OF_CONDUCT.md # Guidelines for contributor behavior +β”‚ +β”œβ”€β”€ DOCUMENTATION.md # Documentation for the project +β”‚ +β”œβ”€β”€ README.md # Overview of the project with instructions +β”‚ +β”œβ”€β”€ app.py # Main application code +β”‚ +β”œβ”€β”€ license.md # Licensing terms for the project +β”‚ +β”œβ”€β”€ requirements.txt # List of dependencies for the project +β”‚ +└── serenifi.pdf # Additional project-related document (e.g., report or presentation) +``` + +## πŸ”₯ Pull Request Process + +Before submitting your Pull Request (PR), ensure the following: + +Complete Testing: Make sure your changes work as expected and have been thoroughly tested. Adhere to Code Guidelines: Follow the project’s code style and guidelines. Include Meaningful Commit Messages: Describe what the PR is solving or adding. Link Issues: If your PR addresses an issue, mention it by adding a link to the issue in the description. + +To submit your PR: + +Push your branch to GitHub: + +``` bash + +git push origin Feature-Name +``` +Go to the repository on GitHub and click New Pull Request. + +Complete the PR template, providing as much detail as possible, and submit it for review. + +## πŸ› Issue Report Process +If you encounter a bug or have an idea for an improvement, please follow these steps to report an issue: + +Search for Existing Issues: Before creating a new issue, check the Issue Tracker to see if the issue has already been reported. Open a New Issue: If the issue hasn’t been raised yet, click on New Issue and fill out the provided template with as much detail as possible. Be Specific: Provide detailed steps to reproduce the issue, the expected result, and the actual result. Include Screenshots/Logs: If applicable, add any relevant screenshots or log files to help us understand and resolve the issue faster. + +## 🌐 Community and Communication +Join the SereniFi community and collaborate with developers from around the world! + +Discord: Join our Discord Community +GitHub Discussions: Engage in discussions via our GitHub Discussions Tab. +Social Media: Stay updated on project news by following us on Twitter and Instagram. +Feel free to ask questions, share ideas, or collaborate with others to make SereniFi better! + +## πŸ“‚ Project Structure +The Project Structure file in the root of the repository provides a detailed breakdown of the directory structure and important files. + +Understanding the project structure will help you easily navigate the codebase and find what you're looking for. Take a look at it before you start contributing! + +## 🌟 Need Inspiration? +Looking for ideas on how to contribute? Here are a few to get you started: + +- New Features: Suggest and build new features like additional meditation sessions, user profiles, or progress tracking. +- UI/UX Improvements: Help enhance the user experience by improving the app’s design and navigation. +- Bug Fixes: Check out the open issues and help squash some bugs. +- Documentation: Improve or extend our documentation to help onboard new contributors. +- There’s something for everyone – find what inspires you and dive in! + +## 🎊 Join the Adventure! πŸ—ΊοΈ +Whether you’re a seasoned developer or a newcomer to open source, we’re thrilled to have you on board! SereniFi is all about promoting mental tranquility, and your contributions are key to achieving that. + +Join us and help create a platform that brings peace to users everywhere! + +Thank you for contributing! Together, we’ll make SereniFi the go-to app for mental well-being. βœ¨πŸŒˆπŸ§˜β€β™€οΈ