Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (59 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

96 lines (59 loc) · 2.75 KB
Raw

Contributing to Global Connect

Thank you for your interest in contributing to the Global Connect project! We welcome contributions from the community to help improve the platform. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

1. Fork the Repository

Start by forking the Global Connect repository on GitHub. This will create a copy of the repository under your GitHub account.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/KOSASIH/Global-Connect.git
cd Global-Connect

3. Create a New Branch

Before making any changes, create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

or for a bug fix:

git checkout -b bugfix/your-bugfix-name

4. Make Your Changes

Make the necessary changes to the codebase. Ensure that your code adheres to the project's coding standards and conventions.

5. Test Your Changes

Run the tests to ensure that your changes do not break any existing functionality. You can run the tests for the backend and frontend as follows:

Backend Tests

Navigate to the backend directory and run:

cd backend
npm test

Frontend Tests

Navigate to the frontend directory and run:

cd ../frontend
npm test

6. Commit Your Changes

Once you are satisfied with your changes, commit them with a descriptive message:

git add .
git commit -m "Add a brief description of your changes"

7. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Create a Pull Request

Go to the original Global Connect repository on GitHub and create a pull request. Provide a clear description of your changes and why they should be merged.

Guidelines for Contributions

  • Code Quality: Ensure that your code is clean, well-organized, and follows the project's coding standards.
  • Documentation: If you add new features or make significant changes, please update the documentation accordingly.
  • Commit Messages: Use clear and concise commit messages that describe the changes made.
  • Issue Tracking: If you are fixing a bug or implementing a feature, consider referencing the related issue in your pull request.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. We expect all contributors to treat each other with respect and kindness.

Questions or Feedback

If you have any questions or need assistance, feel free to reach out to the maintainers via the project's GitHub page or open an issue.

Thank you for contributing to Global Connect! Your efforts help us create a better platform for everyone.