Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.42 KB

README.md

File metadata and controls

92 lines (63 loc) · 3.42 KB
Raw

zc_channels

Team Coelho - Zuri Chat Channels Plugin

Live Site Link:

Project Documentation Link:

Reference

  • Slack
  • Discord

Project Description

The Channel Plugin is a feature that helps users create spaces for conversation and communication on zuri.chat. Users can also create sub tags in the channels option where other things can be done, ranging from game nights, football banter, random, announcement and so much more. This adds the feature of having organized conversations in dedicated spaces called channels.

Benefits of Channels :

  • Channels bring order and clarity to work — you can create them for any project, topic, or team
  • They provide an organised, focused and centeral space for members to have conversations, share files and information.
  • Increased access to shared knowledge across your workspace.
  • Public channels to promote transparency and inclusivity.
  • Private channels are for conversations that should not be open to all members.

Design Link:

Contribution Guide - Steps to Collaborate on the Repository for Team Members

Fork and Clone Repository

  1. Visit the Repository to the Project on Github Website: https://github.com/zurichat/zc_plugin_channels
  2. Fork the repository: Click the "Fork" button on the upper right corner of the Repo page.
  3. Make a Local Clone: Clone the forked repository to your local machine (computer)
    • Click on the "Code" button on the Repo page
    • Copy the URL for the forked Repo "https://github.com/your-github-username/zc_plugin_channels.git"
    • Create a Folder on your Local machine / Computer for the project Workspace
    • Open Command prompt / Terminal in the same folder location
    • In your Terminal, type: git clone@https://github.com/your-github-username/zc_plugin_channels.git

Add "Remote To" and "Pull From" Upstream

  1. Add a Remote to Upstream to your Repo:
    • In your terminal, type: git remote add upstream https://github.com/Valenteeena/zc_plugin_channels
  2. Pull from upstream to download all changes in the project using git pull upstream develop

Finish whatever assigned Task / Issue

  1. Open the Project up in your code Editor
  2. Complete your assigned task / Feature on your local machine.

Create and Commit Changes to a New Branch

  1. When you are ready to add and push your feature / task to the Repo,
    • Create a new branch with your feature / task name you are adding e.g "ft-Add new channel". To do this, type: git checkout -b ft-Add new channel
    • Add your changes using: git add .
    • Commit your changes to the branch with a message using git commit -m "Commit message"
  • * Note: if the Feature is a bug fix, use bug:message for your branch and commit message

Push New Branch to "Origin" Repository

  1. To make sure there are no conflict, Pull from upstream using git pull upstream develop
  2. Push your branch changes to the Repo using git push origin "ft-yourTask"

Create Pull Request

  1. Once you push the changes to your repo, the Compare & pull request button will appear in GitHub page of your repo.
  2. Click the button and make your request. Leave a comment in your request
  3. Click Create pull request to open a new pull request

If you are asked to make changes on the same feature, repeat steps 8 to 13 to add more commits to your pull request.