Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 3.83 KB
Raw

Contributing to Fil+ Backend

First off, thank you for considering contributing to the Fil+ Backend! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Code of Conduct

This project and everyone participating in it is governed by the Filecoin Community Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [abuse@filecoin.io].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for the Fil+ Backend. 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.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • 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 described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for the Fil+ Backend, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Fil+ Backend users.
  • List some other projects where this enhancement exists.

Pull Requests

The process described here has several goals:

  • Maintain Fil+ Backend's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Fil+ Backend
  • Enable a sustainable system for Fil+ Backend's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

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

TypeScript Styleguide

All TypeScript code must adhere to the TypeScript coding guidelines.

Documentation Styleguide

  • Use Markdown for documentation.
  • Reference the methods and classes you're describing.
  • Update the documentation with each change in the codebase that affects how users build, test, and interact with the project.