Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.83 KB

Contributing to SwiftPaste

Thank you for your interest in contributing to SwiftPaste! We welcome contributions from the community to help improve and enhance the extension. Please take a moment to review this guide, which outlines the process for contributing to the project.

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please follow these steps:

  1. Before submitting a new issue, search the existing issues to see if a similar issue has already been reported or discussed.
  2. If you don't find a similar issue, create a new issue and provide a clear and descriptive title and description.
  3. Include steps to reproduce the bug or a detailed explanation of the desired feature.
  4. If possible, include any relevant screenshots or error messages.

Setting up the Project Locally

To set up SwiftPaste locally for development, follow these steps:

  1. Clone the repository: git clone https://github.com/Fralleee/SwiftPaste.git
  2. Install the project dependencies: npm install

Making Changes

  1. Create a new branch from the main branch: git checkout -b my-branch-name
  2. Make the necessary changes and improvements.
  3. Ensure that the code follows the project's coding style and conventions.
  4. Run tests to ensure that everything is functioning correctly: npm test

Submitting a Pull Request

Once you have made your changes and tested them, you can submit a pull request:

  1. Commit your changes: git commit -m "Add a descriptive commit message"
  2. Push your branch to the remote repository: git push origin my-branch-name
  3. Go to the SwiftPaste repository and open a new pull request.
  4. Provide a clear title and description of your changes in the pull request.
  5. Ensure that the pull request adheres to the project's guidelines and conventions.

We appreciate your contribution and will review your pull request as soon as possible. Thank you for helping to make SwiftPaste better!

Please note that by participating in this project, you are expected to follow the Code of Conduct to ensure a respectful and inclusive environment for all contributors.

Want to Contribute?

Contributions to SwiftPaste are welcomed and encouraged! Whether you want to report a bug, suggest a new feature, or submit code changes, we appreciate your contributions.

Please read our Contributing Guide to learn more about how you can contribute to SwiftPaste.

We look forward to your contributions! Thank you for supporting SwiftPaste.

Code of Conduct

Please review our Code of Conduct to understand the expectations for participating in our project and maintaining a respectful and inclusive community environment.