Contributing

Help improve React Native SSH SFTP by contributing code, documentation, issues, and feedback.

Thank you for your interest in improving React Native SSH SFTP.

Whether you want to improve the library, tighten the docs, report a bug, or help other users, contributions are welcome.

You can contribute in a few different ways:

Code Contributions

Add features, fix bugs, improve tests, and help keep the library reliable across iOS and Android.

Documentation Contributions

Improve guides, clarify examples, fix mistakes, and help other developers get up to speed faster.

Issues & Feedback

Report bugs, request improvements, and share details that help reproduce problems.

Community Help

Answer questions, share usage patterns, and help shape the project through discussions.

Before you start

Before opening a pull request:

1. Check whether an issue already exists.
2. If not, raise an issue for the work you plan to do.
3. Fork the repository and clone your fork locally.
4. Create a focused feature branch for your change.

Smaller, focused pull requests are usually easier to review and merge than large mixed changes.

Contributing code

Use this flow for library changes:

1. Fork and clone the repository

   Clone your fork locally:

   git clone https://github.com/your-username/react-native-ssh-sftp.git
   cd react-native-ssh-sftp
   
2. Install dependencies

   Install the project dependencies:

   npm install
   
3. Create a branch

   Create a branch for your work:

   git checkout -b feature/your-feature
   
4. Make your changes

   Follow the existing code style, keep commits clear, and update documentation when your change affects usage or behavior.

5. Open a pull request

   Push your branch, open a pull request, and reference any related issues so reviewers have the right context.

Contributing documentation

If you want to improve the docs, you can either edit directly on GitHub or work locally.

Edit on GitHub

1. Navigate to the page you want to change.
2. Click the edit link on the page.
3. Make your update in GitHub and submit a pull request.

Develop locally

1. Fork and clone the repository.
2. Install dependencies with npm install.
3. Run the docs locally:

npm run docs

1. Open http://localhost:3000 to preview your changes.
2. Commit and submit a pull request when your update is ready.

Where to look next

If you are looking for a good place to start:

• Review the Security guide for responsible vulnerability reporting
• Review the License guide if your work depends on reuse or redistribution terms
• Browse the issue tracker for open work

Writing guidelines

When contributing docs:

• Use an active voice: “Run the command” not “The command should be run”
• Address the reader directly: Use “you” instead of “the user”
• Keep sentences concise: Aim for one idea per sentence
• Lead with the goal: Start instructions with what the user wants to accomplish
• Use consistent terminology: Don’t alternate between synonyms for the same concept
• Include examples: Show, don’t just tell

Submitting changes

When your work is ready:

1. Push your branch to your fork.
2. Open a pull request with a clear description of the change.
3. Link any related issues.
4. Respond to review feedback and update the pull request as needed.

Questions or ideas?

If you are not sure where to start, open an issue or join the GitHub Discussions.

Related resources

• GitHub Discussions
• License
• Security