|
| 1 | +# Contributing to CSI SFIT |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the **CSI SFIT** project! |
| 4 | +We welcome contributions from everyone. Please read these guidelines carefully to help us maintain a collaborative and positive environment. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## Table of Contents |
| 9 | + |
| 10 | +- [How Can I Contribute?](#how-can-i-contribute) |
| 11 | +- [Getting Started](#getting-started) |
| 12 | +- [Code Style Guidelines](#code-style-guidelines) |
| 13 | +- [Commit Messages](#commit-messages) |
| 14 | +- [Submitting a Pull Request](#submitting-a-pull-request) |
| 15 | +- [Reporting Issues](#reporting-issues) |
| 16 | +- [Community Standards](#community-standards) |
| 17 | +- [Contact](#contact) |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## How Can I Contribute? |
| 22 | + |
| 23 | +- **Bug Reports:** Help us improve by reporting issues and bugs. |
| 24 | +- **Feature Requests:** Suggest new features or enhancements. |
| 25 | +- **Pull Requests:** Fix bugs, improve documentation, or add new features. |
| 26 | +- **Documentation:** Help us improve guides, docs, and README files. |
| 27 | +- **Feedback & Ideas:** Share your thoughts and feedback in Discussions or Issues. |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Getting Started |
| 32 | + |
| 33 | +1. **Fork the Repository** |
| 34 | + |
| 35 | + Click the 'Fork' button at the top right of this page to create your own copy. |
| 36 | + |
| 37 | +2. **Clone the Forked Repository** |
| 38 | + |
| 39 | + ```bash |
| 40 | + git clone https://github.com/<your-username>/csi-sfit.git |
| 41 | + cd csi-sfit |
| 42 | + ``` |
| 43 | + |
| 44 | +3. **Install Dependencies** |
| 45 | + |
| 46 | + ```bash |
| 47 | + npm install |
| 48 | + ``` |
| 49 | + |
| 50 | +4. **Create a New Branch** |
| 51 | + |
| 52 | + ```bash |
| 53 | + git checkout -b my-feature-branch |
| 54 | + ``` |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Code Style Guidelines |
| 59 | + |
| 60 | +- Use [Prettier](https://prettier.io/) for code formatting. |
| 61 | +- Follow the existing TypeScript and JavaScript coding style. |
| 62 | +- Write meaningful variable and function names. |
| 63 | +- Use descriptive comments where necessary. |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +## Commit Messages |
| 68 | + |
| 69 | +- Use concise, imperative language (e.g., "Add new event page", "Fix login bug"). |
| 70 | +- Reference related issues (e.g., `Fixes #123`). |
| 71 | + |
| 72 | +Example: |
| 73 | + |
| 74 | +``` |
| 75 | +Add responsive navigation bar |
| 76 | +
|
| 77 | +- Implemented mobile-friendly UI |
| 78 | +- Updated styles for better accessibility |
| 79 | +
|
| 80 | +Fixes #45 |
| 81 | +``` |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## Submitting a Pull Request |
| 86 | + |
| 87 | +1. **Push your changes:** |
| 88 | + |
| 89 | + ```bash |
| 90 | + git push origin my-feature-branch |
| 91 | + ``` |
| 92 | + |
| 93 | +2. **Open a Pull Request:** |
| 94 | + |
| 95 | + - Go to your fork on GitHub. |
| 96 | + - Click "Compare & pull request". |
| 97 | + - Fill in the PR template, describing your changes clearly. |
| 98 | + |
| 99 | +3. **Wait for Review:** |
| 100 | + |
| 101 | + - Address any feedback or requested changes. |
| 102 | + - Once approved, your PR will be merged. |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +## Reporting Issues |
| 107 | + |
| 108 | +- Search [existing issues](https://github.com/AnleaMJ/csi-sfit/issues) before creating a new one. |
| 109 | +- Provide clear steps to reproduce the bug or describe the feature request. |
| 110 | +- Include screenshots, logs, or code snippets if helpful. |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +## Community Standards |
| 115 | + |
| 116 | +- Be respectful and inclusive. |
| 117 | +- Keep discussions constructive and on-topic. |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +## Contact |
| 122 | + |
| 123 | +For questions or support, please [open an issue](https://github.com/AnleaMJ/csi-sfit/issues) or email [us](mailto:movefore@gmail.com). |
| 124 | + |
| 125 | +Thank you for helping make CSI SFIT better! |
0 commit comments