We encourage all community members to contribute to the library. Here are some general guidelines to help you get started:
- Fork the Repository: Start by forking the repository to your GitHub account.
- Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/MWGMorningwood/Immy-Scripts-Shared.git
- Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/your-feature-name
- Make Changes: Make your changes to the PowerShell scripts. Ensure your code follows the repository’s coding standards.
- Commit Changes: Commit your changes with a clear and descriptive commit message.
git commit -m "Add feature/fix description" - Push to GitHub: Push your changes to your forked repository.
git push origin feature/your-feature-name
- Create a Pull Request: Open a pull request from your branch to the our origin repository’s main branch. Provide a detailed description of your changes.
- BEST Practice: Follow Best Practice Guidelines
- Quality and Clarity: Ensure your scripts are well-documented and easy to understand. Include comments where necessary.
- Testing: Test your scripts thoroughly before submitting. Make sure they work as intended and do not cause any unintended side effects.
- Pull Requests: Submit your contributions via pull requests. Provide a detailed description of what your script does and any dependencies it may have. PRs to main will not be accepted.
- Organization: Scripts that have a common usage (like software install/uninstall/versioning) should be foldered by the item they are for.