Dateien nach "docs" hochladen

This commit is contained in:
Niklas Peng 2025-05-30 19:46:08 +02:00
parent f7766fb8eb
commit 8acdc3f2a7
2 changed files with 75 additions and 0 deletions

52
docs/contributing.md Normal file
View File

@ -0,0 +1,52 @@
# Contributing to Code Editor
We love your input! We want to make contributing to Code Editor as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
## Development Process
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## Pull Requests
1. Update the README.md with details of changes if applicable
2. Update the documentation with details of changes if applicable
3. The PR should work for Python 3.6 and above
4. Ensure all tests pass before submitting the PR
## Code Style
We use:
- Black for code formatting
- isort for import sorting
- flake8 for linting
Please run these tools before submitting a PR:
```bash
black .
isort .
flake8
```
Or set up pre-commit hooks:
```bash
pip install pre-commit
pre-commit install
```
## License
By contributing, you agree that your contributions will be licensed under the project's MIT License.

23
docs/index.md Normal file
View File

@ -0,0 +1,23 @@
# Code Editor Documentation
Welcome to the Code Editor documentation.
## Overview
Code Editor is a professional application for editing code with advanced features.
## Installation
Follow the [installation instructions](../README.md#installation) to get started.
## Usage
See the [usage section](../README.md#usage) for basic usage instructions.
## API Reference
(Coming soon)
## Contributing
We welcome contributions! Please see the [contributing guidelines](contributing.md) for more information.