Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 4.08 KB

Contributing.md

File metadata and controls

111 lines (81 loc) · 4.08 KB
Raw

Contributors Guide⚡

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

Creating first Pull Request 🌟

  1. Star this repository.

  2. Fork this repository.

  3. Clone the forked repository.

git clone https://github.com/<your-github-username>/Jarvis.git
  1. Navigate to the project directory.
cd Jarvis
  1. Create a virtual environment.
python -m venv myenv
source myenv/bin/activate  # On Windows, use `myenv\Scripts\activate`
  1. Install the dependencies.
pip install -r requirements.txt
  1. Create a new branch.
git checkout -b <your_branch_name>
  1. Make changes.
  2. Stage your changes and commit them.
git add .
git commit -m "<your_commit_message"
  1. Push your local commits to the remote repository.
git push -u origin <your_branch_name>
  1. Create your Pull Request.
  2. Congratulations! 🎉 you've made your contribution.

Running the Application

  1. Start the application.
streamlit run Jarvis.py
  1. Access the application.

Open your browser and navigate to http://localhost:8501

Important Points to remember while submitting your work 📍

We want your work to be readable by others; therefore, we encourage you to note the following:

  1. Directory names should be in PascalCase letters (e.g., BrainTumorModel, DiabetesModel).
  2. File names should be in camelCase letters (e.g., movieRecommendationModel, latestNews, ticTakToe).
  3. Main function name should be exact name as of fileName.
  4. Don't create more than 3-4 commits until not permitted by Admin and Mentors of the project.
  5. Commit message should be clear. Never write un-necessary things in the commit messages.

Pull Requests Review Criteria 🧲

  1. Please fill the PR Template properly while making a Pull Request.
  2. Never commit in the main branch.
  3. Your work must be original, written by you not copied from other resources.
  4. You must comment on your code where necessary.
  5. For frontend changes, kindly share screenshots and work samples of your work before sending a PR.

Communication and Support 💬

  • Join the project's communication channels to interact with other contributors and seek assistance.
  • If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue.

Code of Conduct 😇

Please follow our project's code of conduct while contributing.
Treat all contributors and users with respect and create a positive and inclusive environment for everyone.

License 📄

The project is licensed under MIT. Make sure to review and comply with the license terms.
We hope this guide helps you get started with contributing to our open-source project. Thank you for your contribution!

Need more help?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Note from Admin ❗

  • We welcome contributions from everyone. However, please avoid spamming the repository with irrelevant issues & pull requests. We reserve the right to mark PRs as invalid if they are not relevant.
I love connecting with different people so if you want to say hi, I'll be happy to meet you more! :)