| 1 |
# Contributing to Friends Plugin |
| 2 |
|
| 3 |
Thank you for considering contributing to the Friends Plugin! We welcome contributions from the community and appreciate your interest in helping us improve our project. |
| 4 |
|
| 5 |
## Table of Contents |
| 6 |
|
| 7 |
- [](#getting-startedGetting Started](#getting-started](#getting-started) |
| 8 |
- [](#coding-guidelinesCoding Guidelines](#coding-guidelines](#coding-guidelines) |
| 9 |
- [](#compiling-scssCompiling SCSS](#compiling-scss](#compiling-scss) |
| 10 |
- [](#submitting-changesSubmitting Changes](#submitting-changes](#submitting-changes) |
| 11 |
- [](#reporting-issuesReporting Issues](#reporting-issues](#reporting-issues) |
| 12 |
|
| 13 |
## Getting Started |
| 14 |
|
| 15 |
1. **Fork the repository**: Click the "Fork" button on the top right corner of this page. |
| 16 |
2. **Clone your fork**: |
| 17 |
```bash |
| 18 |
git clone https://github.com/your-username/friends.git |
| 19 |
``` |
| 20 |
3. **Install Node.js dependencies**: |
| 21 |
Navigate to the project directory and run: |
| 22 |
```bash |
| 23 |
npm install |
| 24 |
``` |
| 25 |
|
| 26 |
## Coding Guidelines |
| 27 |
|
| 28 |
- Follow the existing coding style in the project. |
| 29 |
- Write clear, descriptive commit messages. |
| 30 |
- Ensure your code is well-commented and easy to understand. |
| 31 |
|
| 32 |
## Compiling SCSS |
| 33 |
|
| 34 |
To compile the SCSS files, run the following command in your terminal: |
| 35 |
|
| 36 |
```bash |
| 37 |
npm run sass:compile |
| 38 |
``` |
| 39 |
|
| 40 |
This will process the SCSS files and update the CSS output accordingly. |
| 41 |
|
| 42 |
## Submitting Changes |
| 43 |
|
| 44 |
1. **Create a new feature branch**: |
| 45 |
```bash |
| 46 |
git checkout -b feature/your-feature-name |
| 47 |
``` |
| 48 |
2. **Make your changes**. |
| 49 |
3. **Commit your changes**: |
| 50 |
```bash |
| 51 |
git add . |
| 52 |
git commit -m "Add some feature" |
| 53 |
``` |
| 54 |
4. **Push to your fork**: |
| 55 |
```bash |
| 56 |
git push origin feature/your-feature-name |
| 57 |
``` |
| 58 |
5. **Create a Pull Request**: Go to the original repository and click on the "New Pull Request" button. Select your branch and submit the pull request. |
| 59 |
|
| 60 |
## Reporting Issues |
| 61 |
|
| 62 |
If you encounter any bugs or have suggestions for improvement, please open an issue in this repository. Provide as much detail as possible, including steps to reproduce the issue. |
| 63 |
|
| 64 |
|
