Skip to content

Latest commit

ย 

History

History
30 lines (23 loc) ยท 1.4 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) ยท 1.4 KB
Raw

Thanks for contributing to the Clipboard Project! ๐Ÿ‘‹

Thanks for your interest in contributing to Clipboard! We welcome all types of contributions including code, documentation, bug reports, feature requests, and general suggestions for improving the project.

Guidelines for your valuable contributions

  1. Attribution Please properly attribute your contributors. When submitting your pull request, please include:
  • Detailed explanations of your changes
  • References to relevant issues or discussions
  • Clear attributions to other authors if your changes incorporate their work

  1. Separate Pull Requests Please keep unrelated additions or modifications in separate PRs. This is to allow us to focus on each change individually and provide feedback or action faster.

  2. Code Formatting and Standards Before submitting any code changes please ensure you:

  • Run our provided formatting scripts to ensure consistency within the codebase.
  • Pass all automated tests by running the test suite locally.
  1. Testing and Quality Assurance
  • When submitting code changes, please include relevant tests to help maintain the integrity of the project and ensure you don't introduce bugs.

Getting Started

  1. Fork the repository.
  2. Clone the fork onto your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit with meaningful messages
  5. Run the test suite and formatting scripts
  6. Submit your PR!