Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

45 lines (26 loc) · 2.55 KB
Raw

Contributing to Physiosoft

We warmly welcome contributions and collaborations to the Physiosoft project! Whether you're fixing bugs, adding new features, improving documentation, or sharing feedback, your help is greatly appreciated. Here's how you can contribute:

Getting Started

  • Fork the Repository: Start by forking the Physiosoft repository on GitHub. This creates your own copy of the project where you can make changes.

  • Clone the Forked Repository: Clone your fork to your local machine to start working on the changes.

  • Set Up the Development Environment: Ensure you have the necessary tools installed, such as .NET 8, SQL Server, and an appropriate IDE (like Visual Studio).

Making Changes

  • Create a New Branch: Always create a new branch for your changes. This keeps the main branch stable and makes it easier to manage multiple contributions.

  • Make Your Changes: Implement your changes, adhering to the existing coding standards and architecture. Keep your changes focused and limited to a single feature or bug fix per branch.

  • Write Clear, Commented, and Tested Code: Ensure your code is well-commented, follows the project's style, and is covered by tests if applicable.

Submitting Changes

  • Commit Your Changes: Make regular, small commits with clear commit messages that explain the changes made.

  • Pull the Latest Changes: Regularly pull the latest changes from the main repository to your branch to stay up-to-date and avoid conflicts.

  • Push Your Changes: Push your changes to your fork on GitHub.

  • Create a Pull Request (PR): Submit a PR to the main Physiosoft repository. Your PR should have a clear title and description of the changes. Link any relevant issues.

After Submission

  • Respond to Feedback: The maintainers of the project may provide feedback on your PR. Be open to discussions and make necessary revisions.

  • PR Merging: Once your PR is approved, the maintainers will merge it into the main branch.

General Guidelines

  • Respect the coding and design conventions of the project.
  • Be respectful and constructive when interacting with other contributors and maintainers.
  • Report any bugs or issues you find.
  • Update the documentation if you're introducing changes that affect how users interact with the application.

Need Help?

If you're unsure about something or need help, don't hesitate to open an issue for discussion or ask questions. We want to ensure a welcoming environment where everyone feels encouraged to contribute.

Thank you for contributing to Physiosoft! Your efforts help make this project better for everyone.