Skip to content

Latest commit

 

History

History
242 lines (168 loc) · 10.8 KB

CONTRIBUTING.md

File metadata and controls

242 lines (168 loc) · 10.8 KB
Raw

✨ Contributors Guide ✨

Welcome to our Web Development project! 😍
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Line

Code Of Conduct

Please read and follow our Code of Conduct


Need Help with the Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:

Project Structure 📂

FITFLEX/
├── .github/                  # GitHub-related configurations such as workflows, issue templates, etc.
│   
├── public/                   # Public assets such as images, icons, and static files.
│   
├── src/                      # Source code for the main application or project.
│   
├── .eslintrc.cjs             # ESLint configuration file for code linting.
│     
├── .gitignore                # Specifies which files and directories to ignore in version control.
│   
├── CODE_OF_CONDUCT.md        # Guidelines for community behavior and contribution standards.
│   
├── CONTRIBUTING.md           # Instructions and guidelines for contributing to the project.
│   
├── Dockerfile                # Configuration file for building a Docker image for the project.
│   
├── LICENSE                   # Information about the licensing of the project.
│   
├── README.md                 # Overview, setup instructions, and documentation of the project.
│   
├── SECURITY.md               # Security policies and guidelines for reporting vulnerabilities.
├── index.html                # Main HTML file for the web project or application.
├── netlify.toml              # Configuration file for deploying the project on Netlify.
├── package.json              # Project metadata, scripts, and dependency information for npm.
├── vite.config.js            # Configuration file for Vite, a build tool for front-end development.

What you can Contribute? ✅

🐞Bug Fixing : Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team.

🛠️ Enhance Existing Projects : If you'd like to dive into existing projects, you're welcome to contribute by adding new features, improving user interfaces, optimizing code, or fixing bugs. Your expertise can make a big difference in making these projects even better. 🚀

🧐 Discover and Collaborate: Explore the diverse range of projects in our repository. Find one that aligns with your interests and expertise, and collaborate with the project maintainers and other contributors. Together, we can create exceptional web experiences.

💡 Innovate and Experiment: The FitFlex is an evolving landscape with endless possibilities. Feel free to experiment, push boundaries, and pioneer new ideas. Your innovative contributions can shape the future of the FitFlex.

Line

How to Contribute ? 📰

  • Drop a Star ⭐ in this repo
  • Take a look at the existing Issues.
  • Fork the Repo create a branch for any issue that you are working on and commit your work.
  • At first raise an issue in which you want to work
  • Then after assigning only then work on that issue & make a PR
  • Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
  • All of you can Find the Already existing Web Dev projects in the Projects Folder.
  • REMINDER: Commit inside the Projects Folder & Foldername should not have any space.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.
  • REMINDER: Don't raise more than 2 Issue at a time
  • IMPORTANT: Don't make any type of Pull Request until & unless you get assigned to an Issue
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/FitFlex.git
  1. Navigate to the project directory
cd FitFlex
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution


Alternatively, contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the FitFlex repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the FitFlex repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the FitFlex repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the FitFlex repository.


For Help And Support 💬

  • Admin :- Open Code Crafters
  • Contact :- Email

Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Write Tests

    • Write unit tests for your functions and components.
    • Ensure your tests cover both expected outcomes and edge cases.
    • Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

  5. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission. 😀
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process 📌

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Provide a clear and concise description of the issue.
  3. Wait until someone looks into your report.
  4. Begin working on the issue only after you have been assigned to it. 🚀

Thank you for contributing 💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀

Line

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show some  ❤️  by  🌟  this repository!