Contributing to Flexa

Thank you for your interest in contributing to the Flexa programming language! Flexa is an open-source project, and we welcome contributions from the community. Whether you want to report a bug, suggest a feature, or submit code, your help is appreciated. This guide will walk you through the process of contributing to Flexa.

---

How to Contribute

1. Report Issues

If you encounter a bug or have a suggestion for improvement, please open an issue on the GitHub repository.

• Bug Reports: Provide a detailed description of the issue, including steps to reproduce it and any relevant error messages.
• Feature Requests: Explain the feature you’d like to see and how it would benefit the project.

2. Suggest New Features

Have an idea for a new feature or improvement? Open an issue on the GitHub repository and describe your idea. Be sure to explain the use case and why it would be valuable to the Flexa community.

3. Submit Pull Requests

If you’d like to contribute code, follow these steps:

1. Fork the Repository: Create a fork of the Flexa repository on GitHub.
2. Create a Branch: Create a new branch for your changes.
3. Make Your Changes: Implement your changes and ensure they follow the project’s coding standards.
4. Test Your Changes: Verify that your changes work as expected and do not introduce new issues.
5. Submit a Pull Request: Open a pull request (PR) on the main Flexa repository. Provide a clear description of your changes and reference any related issues.

4. Improve Documentation

Good documentation is essential for any project. If you find areas where the documentation can be improved, feel free to submit changes to the documentation GitHub repository.

---

Coding Standards

To maintain consistency across the codebase, please follow these guidelines:

1. Code Style:
   • Use 4 spaces tab for indentation.
   • Follow the existing naming conventions (e.g., snake_case for variables and functions).
   • Write clear and concise comments where necessary.
2. Testing:
   • Ensure your changes are thoroughly tested.
   • Add new tests if you’re introducing new functionality.
3. Commit Messages:
   • Write clear and descriptive commit messages.
   • Use the present tense (e.g., “add feature X” instead of “added feature X”).
4. Pull Requests:
   • Keep PRs focused on a single issue or feature.
   • Provide a detailed description of your changes.

---

Getting Started

1. Set Up the Development Environment:
   • Clone the repository:

     git clone https://github.com/flexa-script/interpreter.git
     

2. Build and Test:
   • Follow the instructions in the repository’s README to build and test the project.
3. Start Contributing:
   • Pick an issue from the issue tracker or propose a new feature.
   • Follow the steps above to submit your changes.

---

Community Guidelines

• Be Respectful: Treat all community members with respect and kindness.
• Be Open-Minded: Welcome new ideas and perspectives.
• Be Collaborative: Work together to improve the project for everyone.

---

Need Help?

If you have any questions or need assistance, feel free to reach out to the community:

• GitHub Issues: Open an issue on the repository.
• Community Forum: Join the discussion on the Flexa community forum (if available).

---

Thank you for contributing to Flexa! Your efforts help make the language better for everyone.

---

← Back to FAQ and Common Issues