Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (30 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.76 KB

Contributing to CloudFileSystem

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to CloudFileSystem. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the steps and demonstrate the problem.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Java Styleguide

  • Follow standard Java conventions.
  • Use Javadoc for classes and public methods.

TypeScript/React Styleguide

  • Use functional components and Hooks.
  • Ensure strict type checking is enabled.