GITS

GIT Simplified

About GITS

GITS streamlines most frequently performed workflows using fewer commands which is so much easier and better than usual. Git-Simplified AKA GITS can be thought of wrapper around major Git functionalities.

Installation for Linux

1. Clone GITS Repo
2. From the root directory run the following command pip install -r requirements.txt
3. Go to configurations directory and run the following command

If you are working on Linux system with a bash terminal or a Windows system using Windows subsystem for linux:

bash project_init.sh

If you are working on Linux system with a fish terminal:

fish project_init.fish

1. Source the bashrc file

source ~/.bashrc

Note: Open the .bashrc file in User home directory to make sure that the alias command does not have any white spaces in the path. If so, rename the directory to remove the white spaces and re-run the setup.

1. Install pyenv

   1. Consider installing with Homebrew: sh brew update brew install pyenv
   2. Then follow the rest of the post-installation steps, starting with Set up your shell environment for Pyenv.
   3. OPTIONAL. To fix brew doctor's warning ""config" scripts exist outside your system or Homebrew directories"

   If you're going to build Homebrew formulae from source that link against Python like Tkinter or NumPy (This is only generally the case if you are a developer of such a formula, or if you have an EOL version of MacOS for which prebuilt bottles are no longer provided and you are using such a formula).

   To avoid them accidentally linking against a Pyenv-provided Python, add the following line into your interactive shell's configuration:

  - Bash/Zsh:

    ```bash
    alias brew='env PATH="${PATH//$(pyenv root)\/shims:/}" brew'
    ```

  - Fish:

    ```fish
    alias brew="env PATH=(string replace (pyenv root)/shims '' \"\$PATH\") brew"
    ```

Installation for Windows

1. Clone GITS Repo
2. From the root directory run the following command pip install -r requirements.txt

3. Currently, this project cannot be run on Windows. You need to make use of WSL to work on this project in Windows although this fix would only work for systems running Windows 10. If you are using another version of Windows, using a virtual machine might be preferred.

   Please refer this link to enable WSL : https://docs.microsoft.com/en-us/windows/wsl/install-win10
   

How to Contribute?

Please take a look at our CONTRIBUTING.md where we provide instructions on contributing to the repo and help us in enhancing the current video conferencing platforms.

Documentation

Functionalities Implemented

1. gits profile
2. gits rebase
3. gits reset
4. gits revert
5. gits stash
6. gits upstream
7. gits super reset
8. gits commit
9. gits create_branch
10. gits logging
11. gits undo
12. gits untrack
13. gits track
14. gits delete
15. gits sync
16. gits switch
17. gits status
18. gits branch
19. gits diff
20. gits init
21. gits merge
22. gits push
23. gits pull
24. gits fetch
25. gits range diff
26. gits cherry pick

Pydoc implementation

We have tried to write as much documentation as possible. You can use pydoc to go through the documentation. For example if you want to go through all the documentation for all files in code/ directory, do the following:

cd code
python3 -m pydoc -b

This will open up a browser and you can see all the files. You can click on a particular file to access the documentation associated with that file.

This repository is made for CSC 510 Software Engineering Course at NC State University.

Support

Discord Community

Welcome to the GITS Discord community – your central hub for connecting with other GITS enthusiasts, seeking support, and collaborating with developers and contributors. Join our vibrant community by clicking the link below:

Join Discord

Discord Channels:

1. #rules 📜:

• Description: Familiarize yourself with the rules before diving into discussions. Respect and positive vibes are the foundation of our community.

1. #updates 🚀:

• Description: Stay in the loop with the latest news, announcements, and exciting updates about GITS.

1. #support 🛠️:

• Description: Encounter a coding challenge or need assistance with GITS? This channel is your go-to place for community-driven support.

1. #important-links 🔗:

• Description: Access essential links and resources, including documentation and project repositories, to enhance your GITS experience.

1. #general 🌐:

• Description: The heart of our community! Engage in friendly discussions, share coding triumphs, and connect with other GITS enthusiasts.

1. #users 👥:

• Description: Connect with fellow GITS users, share experiences, and seek advice in this user-centric channel.

1. #developers 👩‍💻👨‍💻 (Private):

• Description: A private enclave for developers actively involved in shaping the technical aspects of GITS. Dive into technical discussions and coding wonders.

1. #contributors 👥👩‍💻 (Private):
   • Description: An exclusive space for elite contributors. Collaborate on top-secret projects and actively contribute to the evolution of GITS.

Roles:

1. User 👤:

• Description: The starting point for every GITS adventurer! As a user, you have access to general channels and discussions.

1. Developer 👩‍💻👨‍💻:

• Description: Elevated to Developer status! If you're actively involved in the development of GITS, this role opens the door to the private #developers channel.

1. Contributor 👥👩‍💻:
   • Description: The elite contributors! If you've made significant contributions to GITS, this role grants you access to the private #contributors channel.

Guidelines:

1. Respect and Positive Vibes:

• Description: Treat others with kindness and respect. We're a diverse community with a shared passion for GITS. Let's keep the vibes positive!

1. Clear Communication:

• Description: When seeking support or discussing ideas, provide clear and detailed information. This helps others understand your context and provide better assistance.

1. No Unauthorized Bots:

• Description: To maintain a streamlined experience, refrain from adding unauthorized bots to the server without approval.

1. Constructive Feedback:

• Description: Embrace the spirit of improvement! Provide constructive feedback, share your thoughts on features, and let's collectively enhance GITS.

1. Privacy and Security:

• Description: Protect your privacy! Avoid sharing sensitive information such as passwords or personal details in public channels.

1. Have Fun! 😄:
   • Description: Lastly, let's have a blast! Share funny anecdotes, celebrate each other's victories, and make GITS a place of joy.

Support Email

For more sensitive matters or issues requiring private communication, you can reach out to our support email at gitsimplified@gmail.com. Feel free to use this email for specific concerns or inquiries that may not be suitable for public channels. Guidelines for Email Communication: Clear Subject Line:

When sending an email to support, use a clear and concise subject line that reflects the nature of your inquiry (e.g., "Technical Issue," "Bug Report," "Feature Request"). Detailed Description:

Provide a detailed description of your issue or inquiry in the body of the email. Include relevant information such as the version of GITS you are using, your operating system, and any error messages you've encountered. Attachments (if applicable):

If your inquiry involves screenshots or additional files, feel free to attach them to the email. This can help our support team better understand and address your concern. Continuous Improvement: Your feedback and interactions with our support team contribute to the continuous improvement of GITS. We appreciate your engagement and are dedicated to delivering a positive user experience.

For urgent matters or issues that require immediate attention, please use the #support channel on the Discord server in addition to sending an email.

Thank you for choosing GITS, and we look forward to assisting you through our support email at gitsimplified@gmail.com.