Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.48 KB

Contributing to Share-IT

Thank you for your interest in improving Share-IT! As an open-source project under the GPLv3, we rely on community contributions to make this tool better and more secure.

How to Contribute

1. Reporting Bugs

  • Check the Issues Tab to see if the bug has already been reported.
  • If not, open a new issue. Include a clear title, a description of the problem, and steps to reproduce the error.

2. Suggesting Features

  • Open an issue with the tag "enhancement".
  • Describe why this feature is necessary and how it fits the project's goal of secure file sharing.

3. Development Process

  1. Fork the repository to your own account.
  2. Clone the fork to your local machine.
  3. Create a Branch for your feature or fix: git checkout -b feature/amazing-feature.
  4. Commit your changes with descriptive messages: git commit -m 'Add encryption layer to file uploads'.
  5. Push to your branch: git push origin feature/amazing-feature.
  6. Open a Pull Request (PR) against the main branch of the original repository.

Contribution Standards

  • TypeScript: Ensure all frontend code uses proper types.
  • Documentation: If you add a new feature, update the README or provide a setup guide for it.
  • Testing: Test your changes locally (both frontend and backend) before submitting.

By contributing to this project, you agree that your contributions will be licensed under the GNU GPLv3.