Skip to content

Welcome to PSModule contributing guide

Thank you for investing your time in contributing to this project!

Before you get started, please review the following guidelines: Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue to get your contribution published.

New contributors

To get an overview of the project, read the PSModule README.

Here are some resources to help you get started with open source contributions:

Contribution guidelines

Contributing flow

  1. Open an issue or indicate that you want any of the open issues, so others know what you are working on.
  2. Fork the repository.
  3. Create a branch from main and make your changes.
  4. Write the tests showing the desired functionality first.
  5. Write the code that makes the tests pass.
  6. Open a pull request towards upstream/main as a draft.
  7. Add any details using the PR template.
  8. Link the PR to the issue you opened by adding - Fixes #<issue_number> so that the issue gets associated and closed with the PR.
  9. Review your own PR first! When you are happy with it, mark it as "Ready for review".
  10. Review and address comments on your pull request.
  11. We do not want to close PRs directly if we disagree on a specific approach. Lets discuss it instead. We are happy to help you with your changes if there are some difficult points in the code or framework.
  12. Update your branch with the latest changes from upstream/main before your PR is merged.
  13. Once your pull request is approved, it will be merged and a new feature will be released immediately.

[!IMPORTANT] In rare occation we might create a release branch and do a release from that branch, but that is more for bigger changes. These branches might also run with a prerelease tag, so that we can test the changes before we release it to the public.