Contributing

Guide for contributions to the WvdS FPC RAD Suite.

Thank you for your interest in contributing to the WvdS FPC RAD Suite! This document explains how you can submit contributions.

• Free Pascal Compiler 3.2.2 or higher
• pas2js 2.2.0 or higher
• VS Code 1.85.0 or higher
• Node.js 18+ (for vsce)
• Git

• Pascal/Object Pascal
• Basics of VSCode extensions
• English for code comments

1. Check if the bug has already been reported
2. Create an issue with:
   • Description of the problem
   • Steps to reproduce
   • Expected vs. actual behavior
   • VS Code version, OS, extension version
   • Relevant log output (WVDS: Show Log)

1. Describe the desired feature
2. Explain the use case
3. Outline possible implementations

1. Fork the repository
2. Create a feature branch
3. Implement your change
4. Test locally
5. Create a pull request

• No TODO/ - Complete implementations
• English comments - PasDoc format for public APIs
• Naming conventions - TWvdS* for classes, IWvdS* for interfaces
• i18n - No hardcoded strings, use resourcestrings

• TypeScript/handwritten JavaScript
• Empty exception handlers
• Magic numbers
• SQL string concatenation
• Hardcoded credentials

• Unit names: WvdS.<Category>.<Component>.pas
• Functions: 12-24 lines, max 40
• Parameters: max 5-7
• DRY: No code duplication

# Fork and clone repository
git clone https://github.com/YOUR-USERNAME/WvdS.FPC.git
cd WvdS.FPC
 
# Create feature branch
git checkout -b feature/my-feature

• Write code according to standards
• Test (compile, test extension)
• Commits with meaningful messages

• Describe the change
• Link relevant issues
• Add screenshots (for UI changes)

• Reviewers will provide feedback
• Adjust changes accordingly
• After approval, it will be merged

[ ] Code compiles without errors
[ ] Extension works in testing
[ ] No TODO/FIXME comments
[ ] Public APIs documented
[ ] No hardcoded strings
[ ] No magic numbers
[ ] Tests passed (if applicable)
[ ] CHANGELOG.md updated (for new features)

• Issues: Bug reports, feature requests
• Pull Requests: Code discussions
• Discussions: General questions

By submitting contributions, you agree that your contributions will be released under the same license as the project.

Complete developer guidelines can be found in the Developer Documentation:

• Quality Assurance
• Code Conventions
• Extension Development

• GitHub: WvdS.FPC Repository
• Issues: Bug Reports

• Quality Standards
• FAQ