Skip to content

Latest commit

 

History

History
186 lines (136 loc) · 8.31 KB

Contributing.md

File metadata and controls

186 lines (136 loc) · 8.31 KB
Raw

🛤️ 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:

    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:

git checkout -b "Feature-Name"

  1. Make Your Changes 🛠️: Add your code, test it locally, and ensure everything works.

  2. ** Add and Commit Your Changes 💬:** Save your progress and commit with a meaningful message:

git commit -m "Brief Description of Changes"
  1. Push Your Changes 🚢: Push your feature branch to your remote repository:
git push origin Feature-Name
  1. 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.
  1. Commit Messages:
  • Write clear, meaningful commit messages.
  • Use a brief description that clearly states the purpose of the change.
  1. 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.
  1. Testing:
  • Ensure that your changes are thoroughly tested and do not break existing functionality.
  • Test your code locally before pushing to GitHub.
  1. 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.

│
├── .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:

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. ✨🌈🧘‍♀️