Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (81 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

123 lines (81 loc) · 3.18 KB

Contributing to CSI SFIT

Thank you for your interest in contributing to the CSI SFIT project!
We welcome contributions from everyone. Please read these guidelines carefully to help us maintain a collaborative and positive environment.

Sr. No. Table of Contents
1 How Can I Contribute?
2 Getting Started
3 Code Style Guidelines
4 Commit Messages
5 Submitting a Pull Request
6 Reporting Issues
7 Community Standards
8 Contact

How Can I Contribute?

  • Bug Reports: Help us improve by reporting issues and bugs.
  • Feature Requests: Suggest new features or enhancements.
  • Pull Requests: Fix bugs, improve documentation, or add new features.
  • Documentation: Help us improve guides, docs, and README files.
  • Feedback & Ideas: Share your thoughts and feedback in Discussions or Issues.

Getting Started

  1. Fork the Repository

    Click the 'Fork' button at the top right of this page to create your own copy.

  2. Clone the Forked Repository

    git clone https://github.com/<your-username>/csi-sfit.git
cd csi-sfit

  3. Install Dependencies

    npm install

  4. Create a New Branch

    git checkout -b my-feature-branch

Code Style Guidelines

  • Use Prettier for code formatting.
  • Follow the existing TypeScript and JavaScript coding style.
  • Write meaningful variable and function names.
  • Use descriptive comments where necessary.

Commit Messages

  • Use concise, imperative language (e.g., "Add new event page", "Fix login bug").
  • Reference related issues (e.g., Fixes #123).

Example:

Add responsive navigation bar

- Implemented mobile-friendly UI
- Updated styles for better accessibility

Fixes #45

Submitting a Pull Request

  1. Push your changes:

    git push origin my-feature-branch

  2. Open a Pull Request:

    • Go to your fork on GitHub.
    • Click "Compare & pull request".
    • Fill in the PR template, describing your changes clearly.

  3. Wait for Review:

    • Address any feedback or requested changes.
    • Once approved, your PR will be merged.

Reporting Issues

  • Search existing issues before creating a new one.
  • Provide clear steps to reproduce the bug or describe the feature request.
  • Include screenshots, logs, or code snippets if helpful.

Community Standards

  • Be respectful and inclusive.
  • Keep discussions constructive and on-topic.

Contact

For questions or support, please open an issue or email us.

Thank you for helping make CSI SFIT better!