Thank you for considering contributing to STEP! We value your input and appreciate your efforts to make our project better.
- Ways to Contribute
- Code of Conduct
- Getting Started
- Making Changes
- Submitting a Pull Request
- Code Review
- Community
- Licensing
- Feedback and Questions
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.
- Check out the
good first issue
issues to choose an issue to work on.
Please read and adhere to our Code of Conduct to ensure a positive and inclusive environment for all contributors.
- Fork this repository to your GitHub account.
- Clone your forked repository to your local machine:
git clone https://github.com/<username>/STEP.git
- Install .NET
- (optional) Get an IDE and set it up
- Open your cloned repository
-
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
-
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
-
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 theStepLang.Tests/Examples
folder
- create a new file in the
- To add unit tests, create new Xunit tests in the appropriate
StepLang.Tests
folder
- To add integration tests:
Make sure your code is properly formatted and follows our coding guidelines:
- Format your code using
dotnet format
- Run
dotnet tool install -g dotnet-format
to install it
- Run
- Follow the C# Coding Conventions
- Follow the .NET Design Guidelines
- Commit and push your changes to your forked repository.
- Create a Pull Request from your branch to the main repository's
main
branch. - Provide a clear description of your changes and the problem it solves.
- Your Pull Request will undergo review by maintainers and contributors.
- Address feedback and make necessary changes.
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:
- E-Mail:
- General: [email protected]
- Ricardo Boss: [email protected]
- Discord:
- Ricardo boss: mizzle_de
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!
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!