@neutralinojs/neu/CONTRIBUTING.md

neu CLI for Neutralinojs

# Contributing to neutralinojs-cli

First off, kudos for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to neutralinojs-cli, which is hosted as a part of [Neutralinojs](https://github.com/neutralinojs) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Table Of Contents

- [Code of Conduct](#code-of-conduct)
- [Local Development Setup](#local-development-setup)
- [Making a PR](#making-a-pr)

## Code of Conduct

This project encourages each and everyone to contribute to it. By participating, you are expected to uphold the spirit of open source culture.

## Local Development Setup

1. Fork and clone the repository:

```bash
git clone https://github.com/<your-github-username>/neutralinojs-cli.git
cd neutralinojs-cli
```

2. Install the project dependencies:

```bash
npm install
```

3. Run the CLI locally:

```bash
npm start -- --help
```

The CLI entry point is available at `./bin/neu.js`, so you can also run commands directly with:

```bash
node ./bin/neu.js --help
```

4. Optionally link the local CLI binary if you want to use `neu` directly in your shell or run the current test suite:

```bash
npm link
```

5. Install the test dependencies and run the tests from the `spec/` directory:

```bash
cd spec
npm install
npm test
```

The current test suite executes `neu` as a shell command, so linking the local CLI with `npm link` first makes the tests available in a fresh clone.

## Making a PR

1. **Pick an Issue:** You are welcome to work on any unassigned issue without waiting for explicit confirmation from maintainers. To avoid duplicate work, please leave a comment like _"I am working on this"_ in the issue thread.
2. Fork the latest state of the repo using git.
3. Clone the forked repo and pull it to have the latest code locally. Also, add a Git remote for the original repository.
4. Create a feature branch in which you place your changes. Make sure all your code changes are made in your respective branch.
5. Add proper commit messages to help others understand what you are trying to implement via your branch. Refer [this](https://www.conventionalcommits.org/en/v1.0.0/) for reference.
6. Push the branch to GitHub. Open a pull request from the new branch to the original repo. Clean up after your pull request is merged.
7. Once everything is reviewed, your PR will be merged. Congratulations :tada::tada: