Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.6 KB
Raw

Contributing to Project Builder CLI

We're thrilled that you're interested in contributing to Project Builder CLI! Your contributions will help make the CLI even better and more efficient for developers around the world. Below are the guidelines we'd like you to follow so we can make the contribution process easy and effective for everyone involved.

Got a Question or Problem?

If you have questions about how to use the CLI, please direct these to Stack Overflow and tag them with project-builder-cli. This way, your question can also help others.

If you want to chat in real-time, you can reach out via our official communication channels (add links to Discord, Slack, etc., if you have them).

Found a Bug?

If you've encountered an issue with the CLI, please let us know. First, check our issue tracker to see if someone else has already reported the problem. If not, open a new issue and include as much detail as possible to help us reproduce the bug. This might include:

  • Your environment setup
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Missing a Feature?

Got an idea to make the CLI better? Submit an issue with your feature request. We love to hear about new ideas. If you're able to implement the feature yourself, submit an issue outlining your proposal first so we can discuss its relevance and implementation before you put in the work.

Submission Guidelines

Submitting an Issue

Before submitting your issue, please review the existing issues to avoid duplicates. Clearly describe the issue, including steps to reproduce if applicable.

Submitting a Pull Request (PR)

  1. Fork the repository.
  2. Create a new branch for your fix or feature (e.g., git checkout -b my-awesome-feature).
  3. Make your changes.
  4. Add or update tests as necessary.
  5. Follow the coding standards and guidelines.
  6. Ensure all tests pass.
  7. Commit your changes with a clear and detailed commit message, adhering to our commit message guidelines.
  8. Push your changes and create a pull request to the main branch.

Development Setup

You'll need Node.js version 20 or newer. After cloning the repo, install dependencies and set up your dev environment:

npm install
# follow any specific setup instructions here

Coding Rules

To ensure consistency and quality, please adhere to the coding standards outlined in our documentation. This includes writing tests for all new features and bug fixes.

Naming branching

[type]/task-name_name-abbreviation [feature|bug|hotfix|docs]

For example, feature/implement-husky_DR

Commit Lint

Convention