Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

51 lines (28 loc) · 2.5 KB
Raw

Contributing to Client Uploader

We're thrilled that you're interested in contributing to Client Uploader! Your contributions are essential for keeping this project innovative and accessible. Whether you're fixing bugs, adding new features, or improving documentation, every contribution is valuable.

How to Contribute

  1. Fork the Repository: Start by forking the Client Uploader repository on GitHub.

  2. Clone the Forked Repository: Clone your fork to your local machine to start making changes.

  3. Set Up Your Environment: Make sure you have all necessary development tools installed, including Node.js and npm.

  4. Create a New Branch: Create a new branch for your feature or bug fix. Branch names should be descriptive, like add-new-feature or fix-bug-xyz.

  5. Make Your Changes: Implement your feature or bug fix. Remember to keep your code clean and well-documented.

  6. Write Tests: If you're adding new functionality, please write tests to accompany your changes. This ensures that your feature works as expected and prevents future changes from breaking your work.

  7. Follow Coding Standards: Make sure your code adheres to the coding standards used in Client Uploader. This typically means following stylistic guidelines and using tools like ESLint and Prettier.

  8. Commit Your Changes: Use clear and concise commit messages, describing what you've changed and why.

  9. Push to Your Branch: Push your changes to your fork on GitHub.

  10. Create a Pull Request (PR): Open a PR from your fork to the main Client Uploader repository. Fill out the PR template, clearly describing the changes you've made.

Reporting Bugs

  • Use the GitHub Issues page to report bugs.
  • Check to see if the bug has already been reported.
  • Be as detailed as possible in your bug report. Include steps to reproduce the bug, what you expected to happen, and what actually happened.

Requesting Enhancements

We welcome enhancement requests. Please:

  • Use the GitHub Issues page to suggest enhancements.
  • Explain why this enhancement would be useful to most Client Uploader users.
  • Provide as much detail and context as possible.

Code of Conduct

All contributors are expected to adhere to the project's Code of Conduct. Please read Code of Conduct before contributing.

Thank You

Thank you for contributing to Client Uploader! Your effort and involvement are what make this project great.

Questions?

Feel free to contact us with any questions or concerns. We're here to help!