From 2e384a292ce335d6766af0ebd41ad5a4e23aa320 Mon Sep 17 00:00:00 2001 From: Sainath Rao Pathange <76244077+pathange-s@users.noreply.github.com> Date: Tue, 15 Mar 2022 20:26:44 +0530 Subject: [PATCH] [Documentation]: Add CONTRIBUTING.md to ease and explain contribution guidelines. (#116) * [Documentation]: Add CONTRIBUTING.md to ease and explain contribution guidelines * Update CONTRIBUTING.md with lenient commit rules --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6f8c1a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# 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) +- [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 spirits of open source culture. + +## Making a PR + +1. Fork the latest state of the repo using git. +2. Clone the forked repo and pull it to have latest code locally. Also, add a Git remote for the original repository. +3. Create a feature branch in which you place your changes. Make sure all your code changes are made in your respective branch. +4. 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. +5. 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. +6. Once everything is reviewed, your PR will be merged. Congratulations :tada::tada: The Neutralinojs team thanks you :sparkles: Hope to send you more such :sparkles: