🤝 Contributing Guide - FluxSharp

Guidelines for contributing to FluxSharp. We welcome all contributions!

Table of Contents

1. Getting Started
2. Types of Contributions
3. Development Setup
4. Submitting Changes
5. Code Guidelines
6. Documentation Guidelines
7. Community

Getting Started

Prerequisites

• Git

• Rust toolchain (1.56+)

• C/C++ compiler

• Basic knowledge of FluxSharp

Fork and Clone

1. Fork the repository on GitHub

2. Clone your fork:

   git clone https://github.com/YOUR_USERNAME/flux-sharp.git

3. Add upstream:

   git remote add upstream https://github.com/Yvan4001/FluxSharp.git

4. Create a branch:

   git checkout -b feature/my-feature

Set Up Development Environment

cd flux-sharp
cd fluxcompiler
cargo build
cd ..

Types of Contributions

🐛 Bug Fixes

Found a bug? Help us fix it! Steps:

1. Create an issue describing the bug

2. Fork and create a feature branch

3. Write a test that reproduces the bug

4. Fix the bug

5. Ensure tests pass

6. Submit a pull request

Example:

Issue: Array out of bounds returns wrong error message
Fix: Update error message in bounds checking code
Test: testoutofboundserrormessage()

✨ Features

Want to add a new feature? Steps:

1. Discuss in an issue first (for major features)

2. Implement the feature with tests

3. Document the feature

4. Submit a pull request

5. Respond to feedback

📚 Documentation

Help improve documentation! Types:

• Fix typos and grammar

• Add examples

• Clarify explanations

• Add tutorials

• Update guides

How:

1. Edit

   .md

   files in the

   docs/

   folder

2. Add/improve examples

3. Verify all links work

4. Submit a pull request

🧪 Tests

Improve test coverage! Areas:

• Edge cases

• Error conditions

• Performance scenarios

• Integration tests

Example:

void testArrayBoundsMultipleAccess() {
    int[] arr = new int[5];
    // Test multiple accesses
    // Test boundary conditions
    // Test error handling
}

💡 Ideas & Discussion

Have ideas? Share them!

• Open an issue to discuss

• Share use cases

• Suggest improvements

• Provide feedback

Development Setup

Build the Compiler

cd fluxcompiler
cargo build --release
cd ..

Create Test Files

# Create a test program
echo 'class Main {
    public void main() {
        print("Hello from test!");
    }
}' > test.fsh
Run it
./build.sh test.fsh

Run Tests

# Run all tests
cargo test --all
Run specific test
cargo test testname
Run with output
cargo test -- --nocapture

Create Examples

Place examples in

:

examples/
├── 01helloworld.fsh
├── 02variables.fsh
├── 03functions.fsh
└── 04_classes.fsh

Submitting Changes

Commit Messages

Write clear, descriptive commit messages:

# ✓ Good
commit: Add bounds checking for arrays
Implement runtime bounds verification
Add error messages
Update documentation
✓ Good
commit: Fix compilation error in class methods
✗ Bad
commit: fix stuff
commit: update

Pull Request Process

1. Update your branch:

``

`

`

`

`

`

`

`

// Classes - PascalCase
class UserManager { }

// Methods - camelCase
public void calculateTotal() { }

// Variables - camelCase
int userCount = 0;

// Constants - UPPERSNAKECASE
int MAX_ATTEMPTS = 3;

// ✓ Good - Explains why
// Perform bounds checking before array access
// This prevents buffer overflow attacks
if (index >= array.length()) {
    throw new Exception("Index out of bounds");
}

// ✗ Bad - States obvious
// Check index
if (index >= array.length()) {
    throw new Exception("Index out of bounds");
}

// ✓ Good
try {
    processData(data);
} catch (IOException e) {
    print("Failed to process data: " + e);
    throw new Exception("Processing failed");
}

// ✗ Bad
try {
    processData(data);
} catch (Exception e) {
    // ignore
}

// Write tests for all changes
void testNewFeature() {
    // Arrange
    int input = 5;
    
    // Act
    int result = calculate(input);
    
    // Assert
    assert(result == 10);
}

## Topic Title

Brief introduction.
Subsection
Explanation of concept.
Example
\
\
\
rust
// code example
\
\
\`
Related
Link to related doc

Code Examples

• Must be correct and runnable

• Include comments for clarity

• Show common use cases

• Highlight best practices

Documentation Template

For new features:

1. Overview - What it does

2. Syntax - How to use it

3. Examples - Working code

4. Best Practices - Do's and don'ts

5. Related Links - See also sections

Community

Communication Channels

• GitHub Issues - Bug reports, feature requests

• GitHub Discussions - General discussion

• GitHub Pull Requests - Code review

• Documentation - Best practices and guides

Code of Conduct

Be respectful and inclusive:

• ✓ Do be friendly and professional

• ✓ Do respect different perspectives

• ✓ Do provide constructive feedback

• ✗ Don't be offensive or dismissive

• ✗ Don't spam or flood

• ✗ Don't post private information

Recognition

Contributors are recognized in:

• CONTRIBUTORS file

• Release notes

• GitHub contributors page

Getting Help

Questions

• Check existing documentation

• Search GitHub issues

• Ask in discussions

• Comment on related issues

Stuck on Something?

1. Read the error message carefully

2. Check documentation relevant to the error

3. Search existing issues

4. Ask for help with context and details

Need Review?

For significant changes:

• Create a draft PR first

• Ask for early feedback

• Be open to suggestions

• Iterate together

Recognition & Thanks

First Time Contributing?

Thank you! We appreciate:

• Bug reports

• Documentation improvements

• Code fixes

• Testing and feedback

Regular Contributors

We value your ongoing:

• Code reviews

• Mentoring new contributors

• Documentation maintenance

• Community support

Maintainers

Special thanks to:

• Project founders

• Core maintainers

• Active contributors

• Community members

Common Questions

Q: Can I contribute without coding?

A: Absolutely! We need:

• Documentation writers

• Translators

• Testers

• Community managers

• Example creators

Q: How long until my PR is reviewed?

A: Usually within 1-2 weeks. High-priority items may be faster.

Q: Can I suggest a major feature?

A: Yes! Open an issue to discuss first. We appreciate your ideas.

Q: Do I need to sign a CLA?

A: Check the repository for current requirements.

Q: Can I contribute anonymously?

A: Contributions are tied to GitHub accounts, but you can use a pseudonym.

Resources

• GitHub: FluxSharp on GitHub
• Issues: Report a bug or suggest a feature
• Discussions: Join the community
• Documentation: Contributing docs

Thank You! 🙏

Contributing to FluxSharp helps make it better for everyone. Your time and effort are greatly appreciated! Happy Contributing! 🚀

Last Updated: April 9, 2026 Status: Active ✅ The FluxSharp project welcomes all contributions, from code to documentation to community support.