Skip to content

Latest commit

 

History

History
211 lines (151 loc) · 6.08 KB

CONTRIBUTING.md

File metadata and controls

211 lines (151 loc) · 6.08 KB
Raw

Contributor's Guide

Welcome to BioBranch! 🌿

Thank you for your interest in contributing to BioBranch! This guide will help you get started with the project and make your first contribution.

🌟 Creating Your First Pull Request

  1. Fork the Repository:
    • Go to the repository on GitHub and click "Fork."
    • In the dropdown, choose "+ Create a new Fork" and click "Create Fork."
fork
create-repo
  1. Clone the Forked Repository:
    • From your forked repo, copy the URL: 
      https://github.com/<your-username>/bio-branch.git
    • Clone the repository to your local machine: 
      git clone https://github.com/<your-username>/bio-branch.git
cd bio-branch
    • If you have already forked the project, update your copy before working: 
      git remote update
clone-repo
open-in-vs-code

  1. Navigate to the project directory:

    cd bio-branch

  2. Add Remote Upstream:

    • Add the original repository as an upstream remote to sync future changes: 
      git remote add upstream https://github.com/subhadipbhowmik/bio-branch.git

  3. Verify Remotes:

    • Check that your origin and upstream remotes are set correctly: 
      git remote -v

  4. Sync with Upstream:

    • Pull the latest changes from the upstream repository: 
      git pull upstream main

  5. Install Dependencies:

    • For backend changes: 
      cd server
npm install
npm start
    • For frontend changes: 
      cd site
npm install
npm run dev

  6. Create a Feature Branch:

    • Create a new branch for your changes: 
      git checkout -b <feature-branch>

  7. Make Changes and Track Them:

    • After making changes, track them: 
      git status
git diff

  8. Commit Your Changes:

  • Stage and commit your changes: 
    git add .
git commit -m "Add feature: <description>"

  1. Push Your Changes:

    • Push your feature branch to your remote repository: 
      git push -u origin <feature-branch>

  2. Create a Pull Request:

    • Go to your forked repository on GitHub.
    • Click on the "Compare & pull request" button.
    • Write a title and description for your pull request.
    • Mention the issue number in the pull request description (e.g., "Fixes #1") and submit the PR.

🎉 Congratulations! You’ve made a PR to BioBranch. Wait for it to be reviewed and merged by a maintainer.

Development Workflow 📈

When contributing to BioBranch, please follow these guidelines:

  • Always work on a new branch for each issue or feature.
  • Keep your branch updated with the main repository's master branch.
  • Write clear and concise commit messages.
  • Test your changes thoroughly before submitting a pull request.
  • Keep discussions respectful and constructive.

Issue Report Process 🚩

  1. Go to the project's issues section.
  2. Choose the appropriate template for your issue.
  3. Provide a clear description of the issue.
  4. Wait for someone to look into it before working on it.
  5. Work on the issue only after it has been assigned to you.

Need Help? 🤔

If you're new to Git or GitHub, check out these resources:

You can also reach out to the project maintainers if you're stuck.

Pull Request Process 🚀

  • Ensure that your code is self-reviewed before submitting.
  • Provide a detailed description of the functionality or changes made.
  • Add relevant comments in your code, especially for complex sections.
  • Submit your PR using the appropriate PR template.

Community Guidelines 🤝

Please follow these guidelines while contributing:

  • Be respectful and considerate towards others.
  • Use inclusive language and foster a welcoming environment.
  • Avoid personal attacks, harassment, or discrimination.
  • Keep discussions focused on constructive topics.

Code Reviews ✅

  • Be open to feedback from other contributors.
  • Participate in code reviews to help improve the project.

Feature Requests 🚀

Have an idea for a new feature? Feel free to suggest improvements that can enhance BioBranch.

Spread the Word ☘️

Share BioBranch with others! Promote the project on social media, developer forums, or relevant community platforms.

Important Guidelines ⚡

  1. Contributors should only work on issues that have been assigned to them.
  2. Each pull request should be associated with one issue only.
  3. No minor text edits should be submitted unless necessary.
  4. Unethical behavior, tampering with files, or harassment will result in disqualification.
  5. Follow the community guidelines while contributing to ensure a healthy collaborative environment.

Thank you for your contribution! We truly appreciate it.

Tip from Us 😇

Learning takes time, and it's okay if things don't make sense right away. We believe in you—you’ve got this! 💪

Show some ❤️ by 🌟 BioBranch!