42 lines (33 loc) · 1.55 KB

Contributing to FlexGuard

We welcome contributions! Whether you have a bug report, feature suggestion, or a code change, your input helps make FlexGuard better.

How to Contribute

1. Reporting Issues

Use the GitHub Issues page to report bugs or request features.
Provide as much detail as possible: steps to reproduce, expected behavior, environment, etc.

2. Suggesting Features

Open an issue labeled enhancement.
Clearly describe the problem your feature solves and why it would be beneficial.

3. Submitting Code Changes

Fork the repository.
Create a new branch for your changes:
git checkout -b feature/my-new-feature
Follow coding standards:
- Use English for all comments and commit messages.
- Follow .editorconfig rules (already included in the repository).
Write clear and concise commit messages.

4. Pull Requests

Push your branch to your fork.
Open a Pull Request (PR) to the main repository.
Ensure your PR describes:
- The problem being solved.
- Key changes made.
- Any testing performed.

5. Code Style

All code is written in C# (.NET 8).
Use Spectre.Console for CLI output.
Follow the project's architecture and naming conventions (e.g., interfaces, classes, and namespaces).

6. Testing

If possible, add tests to cover your changes.
Run existing tests before submitting a PR (test framework will be expanded in future versions).

Questions?

If you have any questions, please open a discussion or contact the repository owner.