Skip to content

Contributing.md

Latest commit

 

History

History
103 lines (74 loc) · 3.4 KB

Contributing.md

File metadata and controls

103 lines (74 loc) · 3.4 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. Install Dependencies

Step 1: Install uv (Skip if Already Installed)

Choose the command for your operating system:

On Linux/macOS (using Bash):

curl -LsSf https://astral.sh/uv/install.sh | sh

On Windows (using PowerShell):

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Step 2: Install Project Dependencies

Run this command in your project directory. It automatically creates and uses a virtual environment named .venv.

uv sync
  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.
uv run streamlit run Jarvis.py
  1. Access the application.

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

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! :)