Skip to content

Latest commit

 

History

History
112 lines (82 loc) · 4.14 KB

Contributing.md

File metadata and controls

112 lines (82 loc) · 4.14 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. Use PascalCase for directory/folder names (e.g., BrainTumorModel, DiabetesModel).
  2. Use camelCase for file names (e.g., movieRecommendationModel, latestNews, ticTakToe).
  3. Name the main function exactly the same as the file name.
  4. Limit commits to 3-4 unless given permission by project Admins or Mentors.
  5. Keep commit messages clear and relevant; avoid unnecessary details.

Pull Requests Review Criteria 🧲

  1. Fill out the PR template properly when submitting a pull request.
  2. Do not commit directly to the main branch, or your PR will be instantly rejected.
  3. Ensure all work is original and not copied from other sources.
  4. Add comments to your code wherever necessary for clarity.
  5. Include a working video and show integration with Jarvis as part of your PR.
  6. For frontend updates, share screenshots and work samples before submitting 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! :)