Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

62 lines (51 loc) · 2.12 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct; please follow it in all your interactions with the project.

Pull Request Process

  1. Fork this repository.
  2. Clone the forked repository.
  3. Create a new branch to add the feature.
   git checkout -b <add_new_feature>
  1. Make your changes.
  2. Uncomment the localhost line and comment the nexus-chat line in the following lines of client/realtime/src/app/Screen.js before testing. It should look like the following:
const socket = io.connect("http://localhost:3001");
// const socket = io.connect("https://nexus-chat.glitch.me/");

1

  1. For testing, start the server first.
cd server/
npm start
  1. Then run the client in a new terminal.
cd client/realtime/
npm run dev
  1. Make sure you have installed all the dependencies using npm install.
  2. Before committing changes, make sure to undo the commented lines in client/realtime/src/app/Screen.js. It should look like the following:
"use client";
import React from "react";
import io from "socket.io-client";
import { useEffect, useState } from "react";

//const socket = io.connect("http://localhost:3001");
const socket = io.connect("https://nexus-chat.glitch.me/");

const Screen = () => {
   ...
}
  1. Ensure all your changes are committed and push the branch to your fork.
  2. Create a pull request with a clear title and description of your changes.
  3. Your pull request will be reviewed by the project maintainers, and feedback or requests for changes may be provided.
  4. Once your changes are approved, they will be merged into the main repository. Congratulations on your contribution!

License

By contributing, you agree that your contributions will be licensed under the LICENSE of this project.

Thank you for your contribution!