Skip to content

Latest commit

 

History

History
121 lines (82 loc) · 4.51 KB

Contributing.md

File metadata and controls

121 lines (82 loc) · 4.51 KB
Raw

🚑 AmbuFlow

Thank you for your interest in contributing to AmbuFlow! We’re excited to see what creative ideas you bring. Follow these simple guidelines below to get started.

How to run the project:

  1. Go to Backend folder and run command:
npm install

  1. Make mongodb database.

  2. Go to server.js file and give your mongodb connection URL.

  3. Run command:

node server.js

  1. Split terminal and go to index.html and open it with live server.

  2. make sure that both Backend and index.html file run togethere.

🚀 Getting Started

  1. Fork the repo: Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.

  2. Clone the repo: Clone the forked repository to your local machine using the following command in your terminal:

   git clone https://github.com/<your-github-username>/Bobble-AI.git
  1. Add a remote upstream: Add a remote upstream to the original repository to sync changes from the original repository. Run the following command in your terminal:
git remote add upstream https://github.com/<your-github-username>/Bobble-AI.git
  1. Create a new branch: Create a new branch for your changes. Run the following command in your terminal:
git checkout -b <your-branch-name>

  1. Make changes: Make the desired changes to the source code.

  2. Add your changes: Add your changes to the staging area. Run the following command in your terminal:

git add <File1 changed> <File2 changed> ...
  1. Commit your changes: Commit your changes with a meaningful commit message. Run the following command in your terminal:
git commit -m "files have been changed[specify those here]"
  1. Push your changes: Push your changes to your forked repository. Run the following command in your terminal:
git push origin <your-branch-name>
  1. Create a PR: Go to the GitHub page of your forked repository. You should see a prompt to create a pull request (PR). Click on it, compare the changes, and create the PR.

Contribute using GitHub Desktop(Alternative)

  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 Stackoverflow-Analysis repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the Stackoverflow-Analysis 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 Stackoverflow-Analysis 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 Stackoverflow-Analysis repository.

🎉 Additional Notes

  • Make sure to sync your fork with the latest changes from the original repo before pushing new features.
  • Respect coding conventions and keep your code clean. Comment your changes for ease in review.

Welcome to Open-Source and thank you for contributing! 🙌