Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 5.02 KB

CONTRIBUTING.md

File metadata and controls

130 lines (93 loc) · 5.02 KB
Raw

Contributing to STEP

Thank you for considering contributing to STEP! We value your input and appreciate your efforts to make our project better.

Table of Contents

  1. Ways to Contribute
  2. Code of Conduct
  3. Getting Started
  4. Making Changes
  5. Submitting a Pull Request
  6. Code Review
  7. Community
  8. Licensing
  9. Feedback and Questions

Ways to Contribute

There are several ways you can contribute to STEP:

  • Reporting issues and suggesting improvements through GitHub Issues.
  • Submitting code enhancements or bug fixes through Pull Requests.
  • Improving our documentation.

Code of Conduct

Please read and adhere to our Code of Conduct to ensure a positive and inclusive environment for all contributors.

Getting Started

Forking the Repository

  1. Fork this repository to your GitHub account.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/<username>/STEP.git

Setting Up Your Local Environment

  1. Install .NET
  2. (optional) Get an IDE and set it up
  3. Open your cloned repository

Making Changes

Creating a Feature Branch

  1. Create a new branch for your feature or bug fix:

    # if an issue you want to fix exists, use issues/<id>-<description>:
git checkout -b issues/26-contribution-docs

# if no issue exists or is not applicable, choose an appropriate category and give it a short description:
git checkout -b meta/change-project-name
# or:
git checkout -b workflow/add-build-scripts

  2. Commit your changes

    • Make sure your changes are not out-of-scope for the issue you are working on
    • Create small commits and put the idea behind each change in the commit message

  3. Write tests

    • To add integration tests:
      • create a new file in the StepLang/Examples folder
      • Add a file with the same name and the extension .step.out with the expected output in the StepLang.Tests/Examples folder
    • To add unit tests, create new Xunit tests in the appropriate StepLang.Tests folder

Coding Guidelines

Make sure your code is properly formatted and follows our coding guidelines:

Submitting a Pull Request

  1. Commit and push your changes to your forked repository.
  2. Create a Pull Request from your branch to the main repository's main branch.
  3. Provide a clear description of your changes and the problem it solves.

Code Review

  • Your Pull Request will undergo review by maintainers and contributors.
  • Address feedback and make necessary changes.

Community

Join our community on Discord to connect with other contributors, ask questions, and discuss development.

In case you want to contact the maintainers privately, you can reach out to us here:

Licensing

When you submit a contribution to the STEP project, you are agreeing to license your code under the same open-source license as the rest of the project, as specified in our project's license file (LICENSE.md).

While you retain the copyright to your code, it will be available to the public under the project's license terms. Ensure that any third-party code or libraries in your contribution are compatible with our project's license.

Note that the project maintainers may update the license in the future, and contributions made after a license change will be subject to the new terms. Your submission acknowledges and accepts these licensing terms.

Thank you for your contribution to STEP!

Feedback and Questions

If you have any questions or need assistance, feel free to reach out on Discord or open an issue on GitHub.

We appreciate your contributions to make STEP better for everyone!