Skip to content

Contributing

Contribution Guidelines for PSCloudPC

Welcome to PSCloudPC! We appreciate your interest in contributing. Before you get started, please take a moment to review the following guidelines to ensure a smooth and collaborative contribution process.

New Ideas

  • We encourage you to share your innovative ideas and suggestions for improving PSCloudPC.
  • Feel free to open an issue on GitHub to propose new features, enhancements, or changes to the existing functionality.
  • Provide a clear and detailed description of your idea and explain how it aligns with the project's goals.

Bug Reports

  • If you encounter a bug or an issue while using PSCloudPC, please help us by reporting it.
  • Before reporting, check the existing issues on GitHub to avoid duplicates.
  • Clearly describe the problem, including steps to reproduce it, and provide any relevant error messages or screenshots.
  • Mention the version of PSCloudPC you are using, as well as the operating system and environment details.

Fixing Typos and Documentation

  • If you notice any typos, grammatical errors, or unclear sections in the project documentation or code comments, we appreciate your effort in fixing them.
  • Fork the repository, make the necessary changes, and submit a pull request.
  • Ensure that your changes maintain consistent coding style and follow any existing conventions in the project.

Dos

  • Familiarize yourself with the project's existing codebase, documentation, and issue tracker before contributing.
  • Follow the coding style, naming conventions, and guidelines used throughout the project.
  • Write clear, concise, and well-documented code that is easy to understand and maintain.
  • Test your changes thoroughly to ensure they do not introduce new issues.
  • Be respectful and considerate when interacting with other contributors and maintain a positive and inclusive environment.

Don'ts

  • Do not submit large, sweeping changes without discussing them first. Open an issue to propose major changes and get feedback from the project maintainers and the community.
  • Avoid introducing unnecessary dependencies or breaking existing functionality with your changes.
  • Refrain from submitting incomplete or untested code.

Licensing

  • By contributing to PSCloudPC, you agree that your contributions will be licensed under the same license as the project itself, unless explicitly stated otherwise.

We value your contributions and thank you for helping improve PSCloudPC. Your involvement and support are crucial to its success. If you have any questions, feel free to reach out to us on GitHub or through other communication channels mentioned in the project's documentation.

Happy coding and contributing!