Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 2.52 KB
Raw

Contribution Guide

Thank you for your interest in contributing to our project! To make your contribution as effective and useful as possible for the community, please follow the guidelines below.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top of the repository page to create a copy of the project in your GitHub account.
  2. Clone the repository: Clone your forked repository to your local machine using the command: 
    git clone https://github.com/YOUR_USERNAME/PROJECT_NAME.git
  3. Create a branch: Create a new branch for your work. Never work directly in the main branch. 
    git checkout -b branch-name

Writing Code

  1. Follow the coding style: Please adhere to the coding standards accepted in the project. Use EditorConfig to configure formatting.
  2. Write tests: Ensure that your code is covered by tests. Use nUnit or any other preferred tool for writing unit tests.
  3. Document your code: Write clear comments and update documentation if your code introduces changes that require it.

Submitting Changes

  1. Ensure your code works: Before submitting changes, make sure your code compiles and all tests pass successfully.
  2. Create a pull request: Push your changes to GitHub and create a pull request in the main repository. Make sure your pull request describes the changes made and justifies the need for these changes.
  3. Discuss and revise: Be prepared to discuss your changes. We may ask you to make adjustments before merging the pull request.

Reporting Issues

  1. Check existing issues: Before creating a new issue, make sure a similar issue has not already been created.
  2. Create a detailed description: If you find a new issue, create an issue with a detailed description of the problem, steps to reproduce it, the expected result, and the current behavior.

Acknowledgments

Thank you for your interest and willingness to help make our project better! Your contribution is appreciated and helps develop the community.

Contacts

If you have any questions or need assistance, please contact us at support@recloud.tech.

This file is based on best practices and recommendations for contributing to open source projects.


This document provides clear and understandable instructions for project contributors, helping them get started, follow project standards, and effectively submit changes. Don't forget to replace `[YOUR EMAIL]` with a real email address for contact.