80 lines
1.8 KiB
Markdown
80 lines
1.8 KiB
Markdown
**English** | [Русский](../legal.ru/CONTRIBUTING.md)
|
|
|
|
# Contributor Guide
|
|
|
|
## Licensing
|
|
|
|
By contributing to the DLE (Digital Legal Entity) project, you agree that your code will be distributed under the **Proprietary Software License**.
|
|
|
|
## Copyright
|
|
|
|
All contributors must:
|
|
- Include their name in commits
|
|
- Agree to transfer rights to the code to the project author
|
|
- Not infringe third-party copyrights
|
|
|
|
## Contribution Process
|
|
|
|
### 1. Preparation
|
|
- Fork the repository
|
|
- Clone your fork locally
|
|
- Create a feature branch for your changes
|
|
|
|
### 2. Development
|
|
- Follow the project's coding standards
|
|
- Add code comments in English (or the project's primary language)
|
|
- Test your changes
|
|
|
|
### 3. Commits
|
|
- Use clear commit messages
|
|
- Include your name in commits
|
|
- Split large changes into logical parts
|
|
|
|
### 4. Pull Request
|
|
- Create a Pull Request with a description of changes
|
|
- Explain what issues your code addresses
|
|
- Wait for review from the project author
|
|
|
|
## Code Standards
|
|
|
|
### Naming
|
|
- Files and folders: kebab-case
|
|
- Variables and functions: camelCase
|
|
- Constants: UPPER_SNAKE_CASE
|
|
- Classes: PascalCase
|
|
|
|
### Comments
|
|
|
|
```javascript
|
|
/**
|
|
* @copyright 2024-2026 Alexander Viktorovich Tarabanov
|
|
* @license Proprietary
|
|
* @author [Your name] <your-email@example.com>
|
|
*/
|
|
```
|
|
|
|
### Git messages
|
|
|
|
```
|
|
feat: add new authentication function
|
|
fix: fix data validation error
|
|
docs: update API documentation
|
|
style: code formatting
|
|
refactor: refactor user module
|
|
test: add tests for new functionality
|
|
```
|
|
|
|
## Contacts
|
|
|
|
### For contribution questions:
|
|
- **Email:** info@hb3-accelerator.com
|
|
- **GitHub Issues:** [Create issue](https://github.com/VC-HB3-Accelerator/DLE/issues)
|
|
|
|
### Project author:
|
|
**Alexander Viktorovich Tarabanov**
|
|
Email: info@hb3-accelerator.com
|
|
|
|
---
|
|
|
|
**Thank you for contributing to the DLE project!**
|