Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (68 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 3.45 KB

Contributing to Semantic Flow Language (SFL)

Thank you for your interest in contributing to the Semantic Flow Language (SFL) project!
This document provides guidelines on how to contribute to the project, report issues, and suggest new features.

We welcome all contributions, whether you’re adding new features, fixing bugs, or improving documentation.

Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Reporting Bugs
  4. Submitting Changes
  5. Community

How to Contribute

To ensure a smooth contribution process, please follow these steps when you want to contribute:

  1. Fork the repository to your own GitHub account and clone it to your local machine.

  2. Create a new branch for your changes:

    git checkout -b feature-name

  3. Make your changes — ensure that your code is clear, well-documented, and follows the existing style.

  4. Test your changes thoroughly.

  5. Commit your changes with clear and concise messages:

    git commit -m "Add feature/bugfix: Describe the change"

  6. Push your changes to your fork:

    git push origin feature-name

  7. Create a pull request (PR) to the main repository, providing a clear description of what your changes do and why they’re needed.

We encourage contributors to break their changes into small, manageable PRs.
Larger contributions should be discussed before starting work.

Code of Conduct

We want the SFL community to be a welcoming and supportive environment for everyone.
Please adhere to the following principles:

  • Be respectful: Treat everyone with kindness and respect, even if you disagree.
  • Be open: We value diverse perspectives and encourage constructive feedback and discussion.
  • Be collaborative: Share your ideas and knowledge to help others improve.

If you need to report an incident, please contact us directly through repository issues or via email.

Reporting Bugs

If you discover a bug or unexpected behavior in the SFL project, please report it by following these steps:

  1. Search existing issues
    Before creating a new issue, check the GitHub Issues page to see if your bug has already been reported.

  2. Provide details
    Include as much information as possible in your report:

    • A clear description of the problem
    • Steps to reproduce the issue
    • Expected vs. actual results
    • Any relevant error messages or logs

The more information you provide, the easier it will be for us to fix the issue.

Submitting Changes

If you want to contribute code, please follow these guidelines:

  • Follow existing code style
    Ensure your code aligns with the project’s established style and conventions.

  • Document your changes
    If your change is significant, update or add documentation where necessary.

  • Write tests
    When fixing bugs or adding features, include tests to prevent regressions.

  • Link to an issue
    If your PR addresses an existing issue, mention it in the PR description
    (e.g., Closes #12).

Community

SFL is an open project, and we value community involvement.
You can participate in discussions, report issues, and suggest new features.

Join the community through:

  • GitHub Issues
  • Discussion forum (if available)

Thank you for contributing to the future of AI-assisted, human-aligned development.
We look forward to your contributions.