Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 2.91 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

Before opening a Pull Request

We recommend opening an issue before a substantial Pull Request if there isn’t already an issue for what you’d like to contribute. This helps facilitate a discussion before deciding on an implementation approach.

For some changes, such as typo fixes, documentation enhancements, or broken links, it may be suitable to open a small Pull Request by itself.

How to open a Pull Request

  1. Check the issues or open a new one
  2. Fork this repository
  3. Create your feature branch: git checkout -b my-new-feature
  4. Commit your changes: git commit -am 'feat: Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request linked to the issue 1.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the overall style of the project
  • Write tests
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests
  • Write good commit messages following conventional commits
  • Open a pull request with a title following conventional commits

Running Unit and Integration Tests

Running git workflows locally

Act is a tool that will use docker to build and test workflows locally.

1. Act setup

  • Follow the instructions to install act
  • To check all available actions: act -l

2. Run tests

  • To run the default (push) event: act
  • To run a specific job: act -j build

Alternatively, you can run unit and integration tests with the following commands:

For unit tests only:

dotnet test LoadShedding.sln --filter Category=Unit

For integration tests only:

dotnet test LoadShedding.sln --filter Category=Integration

Resources

Disclaimer

By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement