Skip to content

Add CONTRIBUTING.md #11

@simonedevit

Description

@simonedevit

Add CONTRIBUTING.md file to provide clear guidance for developers and collaborators who want to help improve the project.

  • How to Contribute:

    • Submitting bug reports or feature requests (e.g., via GitHub Issues).
    • Guidelines for proposing changes (e.g., pull requests).
  • How to Get Started:

    • Setting up the development environment.
    • Build and symlink the project.
    • Running tests.
  • Coding Standards:

    • Code style, formatting, or tools (like linting or Prettier).
    • Naming conventions for files or functions.
  • Workflow:

    • Steps to fork, clone, branch, commit, and push.
    • Best practices for creating pull requests (e.g., "keep them small and focused").
  • Etiquette:

    • Behavior guidelines (e.g., follow the project's Code of Conduct).
    • Communication tips for opening issues or discussing features.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions