|
| 1 | +# Contributing to SDR-RPC |
| 2 | + |
| 3 | +Thank you for considering contributing to **SDR-RPC**! Your input, feedback, and contributions help make this project better for everyone. Whether you're submitting a bug report, suggesting a new feature, or contributing code, this guide will help you get started. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## How Can You Contribute? |
| 8 | + |
| 9 | +### Reporting Bugs |
| 10 | +If you find a bug, please help us by reporting it. When creating a bug report, provide as much detail as possible to make it easier for us to investigate and resolve the issue. |
| 11 | + |
| 12 | +#### Steps for Reporting Bugs: |
| 13 | +1. Check the [issues page](https://github.com/EnderIce2/SDR-RPC/issues) to see if the bug has already been reported. |
| 14 | +2. If not, create a new issue and include: |
| 15 | + - A clear and descriptive title. |
| 16 | + - Steps to reproduce the issue. |
| 17 | + - Your system configuration (OS version, SDRSharp version, etc.). |
| 18 | + - Any error logs or screenshots that might help. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +### Suggesting Features or Enhancements |
| 23 | +Have an idea to improve SDR-RPC? We’d love to hear it! |
| 24 | + |
| 25 | +#### Steps for Suggesting Features: |
| 26 | +1. Check the [issues page](https://github.com/EnderIce2/SDR-RPC/issues) to ensure the feature hasn't already been requested. |
| 27 | +2. Create a new issue and include: |
| 28 | + - A clear description of the feature or enhancement. |
| 29 | + - Why this feature would be useful. |
| 30 | + - Any relevant examples or references. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +### Contributing Code |
| 35 | +We welcome pull requests for bug fixes, features, or documentation improvements. |
| 36 | + |
| 37 | +#### Steps for Code Contributions: |
| 38 | +1. **Fork the Repository** |
| 39 | + - Navigate to the project repository and click **Fork**. |
| 40 | +2. **Clone Your Fork** |
| 41 | + - Clone the repository to your local machine: |
| 42 | + ```bash |
| 43 | + git clone https://github.com/your-username/SDR-RPC.git |
| 44 | + ``` |
| 45 | +3. **Create a New Branch** |
| 46 | + - Use a descriptive name for your branch: |
| 47 | + ```bash |
| 48 | + git checkout -b feature/your-feature-name |
| 49 | + ``` |
| 50 | +4. **Write and Test Your Code** |
| 51 | + - Follow the coding standards used in the project. |
| 52 | + - Ensure your code works by testing it thoroughly. |
| 53 | +5. **Commit Your Changes** |
| 54 | + - Write a clear and concise commit message: |
| 55 | + ```bash |
| 56 | + git commit -m "Add a clear description of the changes" |
| 57 | + ``` |
| 58 | +6. **Push Your Changes** |
| 59 | + - Push your branch to your forked repository: |
| 60 | + ```bash |
| 61 | + git push origin feature/your-feature-name |
| 62 | + ``` |
| 63 | +7. **Create a Pull Request** |
| 64 | + - Open a pull request from your branch to the `main` branch of the repository. |
| 65 | + - Include a detailed description of your changes. |
| 66 | + |
| 67 | +#### Guidelines: |
| 68 | +- Ensure your code adheres to the existing coding style. |
| 69 | +- Document your changes if they impact functionality. |
| 70 | +- Keep pull requests focused—address one issue or feature per PR. |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +### Improving Documentation |
| 75 | +If you spot errors or outdated information in the documentation, feel free to submit corrections. This includes the `README.md`, `CONTRIBUTING.md`, and in-code comments. |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## Development Environment Setup |
| 80 | + |
| 81 | +To contribute effectively, set up your environment using the following steps: |
| 82 | +1. Install [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) or later. |
| 83 | +2. Install the [.NET Framework 4.6 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer). |
| 84 | +3. Download the [SDRSharp Plugin SDK](https://airspy.com/?ddownload=5944). |
| 85 | +4. Clone the repository and open the `SDRSharpPlugin.DiscordRPC.sln` file in Visual Studio. |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +## Code of Conduct |
| 90 | + |
| 91 | +By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please treat others with respect and professionalism. |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +Thank you for contributing to SDR-RPC! If you have any questions, feel free to ask on the [issues page](https://github.com/EnderIce2/SDR-RPC/issues). |
0 commit comments