update
This commit is contained in:
@@ -0,0 +1,92 @@
|
||||
# Contributing to FileRise
|
||||
|
||||
Thank you for your interest in contributing to FileRise! We appreciate your help in making this self-hosted file manager even better.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Reporting Bugs](#reporting-bugs)
|
||||
- [Suggesting Enhancements](#suggesting-enhancements)
|
||||
- [Pull Requests](#pull-requests)
|
||||
- [Coding Guidelines](#coding-guidelines)
|
||||
- [Documentation](#documentation)
|
||||
- [Questions and Support](#questions-and-support)
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Fork the Repository**
|
||||
Click the **Fork** button on the top-right of the FileRise GitHub page to create your own copy.
|
||||
|
||||
2. **Clone Your Fork**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/FileRise.git
|
||||
cd FileRise
|
||||
```
|
||||
|
||||
3. **Set Up a Local Environment**
|
||||
FileRise runs on a standard LAMP stack. Ensure you have PHP, Apache, and the necessary dependencies installed. For frontend development, Node.js may be required for build tasks if applicable.
|
||||
|
||||
4. **Configuration**
|
||||
Copy any example configuration files (if provided) and adjust them as needed for your local setup.
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
If you discover a bug, please open an issue on GitHub and include:
|
||||
|
||||
- A clear and descriptive title.
|
||||
- Detailed steps to reproduce the bug.
|
||||
- The expected and actual behavior.
|
||||
- Screenshots or error logs (if applicable).
|
||||
- Environment details (PHP version, Apache version, OS, etc.).
|
||||
|
||||
## Suggesting Enhancements
|
||||
|
||||
Have an idea for a new feature or improvement? Before opening a new issue, please check if a similar suggestion already exists. If not, open an issue with:
|
||||
|
||||
- A clear description of the enhancement.
|
||||
- Use cases or examples of how it would be beneficial.
|
||||
- Any potential drawbacks or alternatives.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
We welcome pull requests! To submit one, please follow these guidelines:
|
||||
|
||||
1. **Create a New Branch**
|
||||
Always create a feature branch from master.
|
||||
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
2. **Make Your Changes**
|
||||
Commit your changes with clear, descriptive messages. Make sure your code follows the project’s style guidelines.
|
||||
|
||||
3. **Write Tests**
|
||||
If applicable, add tests to cover your changes to help us maintain code quality.
|
||||
|
||||
4. **Submit the Pull Request**
|
||||
Push your branch to your fork and open a pull request against the master branch in the main repository. Provide a detailed description of your changes and why they’re needed.
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
- **Code Style:**
|
||||
Follow the conventions used in the project. Consistent indentation, naming conventions, and clear code organization are key.
|
||||
|
||||
- **Documentation:**
|
||||
Update documentation if your changes affect the usage or configuration of FileRise.
|
||||
|
||||
- **Commit Messages:**
|
||||
Write meaningful commit messages that clearly describe the purpose of your changes.
|
||||
|
||||
## Documentation
|
||||
|
||||
If you notice any areas in the documentation that need improvement or updating, please feel free to include those changes in your pull requests. Clear documentation is essential for helping others understand and use FileRise.
|
||||
|
||||
## Questions and Support
|
||||
|
||||
If you have any questions, ideas, or need support, please open an issue or join our discussion on [GitHub Discussions](https://github.com/error311/FileRise/discussions). We’re here to help and appreciate your contributions.
|
||||
|
||||
---
|
||||
|
||||
Thank you for helping to improve FileRise and happy coding!
|
||||
|
||||
Reference in New Issue
Block a user