Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

52 lines (41 loc) · 2.27 KB

Contributing Guidelines

Welcome to the UC Main CSPS Web App repository! We appreciate your interest in contributing. To ensure a smooth and collaborative experience, please take a moment to review these guidelines.

Table of Contents

Getting Started

Prerequisites

Installation

  1. Fork the repository and clone it locally.
  2. Navigate to the project directory.
  3. Install the dependencies: npm install

How to Contribute

Reporting Issues

If you encounter any issues or have suggestions for improvement, please feel free to submit a GitHub issue. When reporting an issue, please provide the following details:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any relevant error messages or screenshots

Submitting Pull Requests

We welcome pull requests for bug fixes, feature enhancements, and other improvements. To submit a pull request, please follow these steps:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your changes: git checkout -b my-branch
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your branch to your forked repository.
  5. Open a pull request on the main repository.

Code Style and Guidelines

To maintain code consistency and readability, please adhere to the following guidelines:

  • Follow the JavaScript Standard Style for coding style and formatting.
  • Write clear and concise code with appropriate comments where necessary.
  • Ensure your changes adhere to the project's overall architecture and design principles.

License

The software in this repository is protected by copyright laws. All rights are reserved by UC Main CSPS. Unauthorized reproduction, modification, or distribution of this code is strictly prohibited without the prior written consent of the copyright holder.

Thank you for your contributions and understanding of the licensing requirements.