Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.54 KB

contributing.md

File metadata and controls

78 lines (51 loc) · 2.54 KB
Raw

Contributing to Filecoin Developer Console and Starter Kit

Thank you for your interest in contributing to the Filecoin Developer Console and Starter Kit! We're excited to have you join our community of developers and contributors. This document provides guidelines for contributing to this project.

Project Status

This is an early version of the Filecoin Developer Console and Starter Kit. We're excited about the potential to add more features and improve the existing ones. Your contributions can help shape the future of this tool for the Filecoin developer community.

How to Contribute

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest features.
  • Before creating a new issue, please check if a similar issue already exists.
  • Provide as much context as possible when reporting bugs. Include your operating system, browser version, and steps to reproduce the issue.

Submitting Changes

  1. Fork the repository.
  2. Create a new branch for each feature or bugfix.
  3. Make your changes in the new branch.
  4. Submit a pull request (PR) to the main branch of this repository.

Pull Request Guidelines

  • Provide a clear description of the problem and solution in your PR description.
  • Include the relevant issue number if applicable.
  • Ensure your code adheres to the existing style of the project to maintain consistency.
  • Make sure all tests pass and add new tests when necessary.

Development Setup

  1. Clone your fork of the repository.

  2. Install dependencies:

    npm install

    or

    yarn install

  3. Run the development server:

    npm run dev

    or

    yarn dev

Areas for Contribution

We welcome contributions in various areas, including but not limited to:

  • Adding new Filecoin starter kits
  • Enhancing existing starter kit documentation
  • Improving the user interface and user experience of the Developer Console
  • Adding new features to the Developer Console
  • Optimizing performance
  • Writing and improving documentation
  • Adding more comprehensive testing

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [project maintainer's email].

Questions?

If you have any questions or need further clarification on how to contribute, please don't hesitate to reach out by creating an issue or contacting the project maintainers.

We're excited to see your contributions and work together to make the Filecoin Developer Console and Starter Kit even better!