Contributing

How can I contribute some changes to FluentFTP?

First you must "fork" FluentFTP, then make changes on your local version, then submit a "pull request" to request me to merge your changes. To do this:

1. Click Fork on the top right of this page
2. Open your version here : https://github.com/YOUR_GITHUB_USERNAME/FluentFTP
3. Download Github Desktop and login to your account
4. Click File > Clone repository... and select FluentFTP in the list
5. Edit "Local path" with the folder where you want to place the source code and press Clone
6. Edit the project using Visual Studio 2017 Community or better
7. Switch to Github Desktop, which should now show a list of the changed files
8. Type a Commit Summary (bottom left), and click Commit
9. Click Push to origin (top right)
10. Open the pull requests page to create a PR
11. Click New pull request (top right)
12. Click compare across forks (blue link, top right)
13. On the right "head fork" select the fork with your username
14. Click Create pull request
15. Summarize the changes you made in the title
16. Type details about the changes you made in the description
17. Click Create pull request
18. Thank you!

What is the criteria for acceptable pull requests?

1. A valid fix or feature implementation
2. Alpha testing performed by the contributor shows a positive change or successful fix
3. All automated tests must pass (unit & integration)
4. Follows C# best practices and industry conventions
5. Clean and structured code
6. Follows FluentFTP conventions in regard to source code organization structure and naming scheme
7. Only API methods usable by end users must be public, everything else must be private or internal
8. Important or complicated sections must be documented (commented in the code itself)
9. Add references to FluentFTP issue tickets where possible to show which issue was catered to