Skip to content

Commit

Permalink
[Documentation]: Add CONTRIBUTING.md to ease and explain contribution…
Browse files Browse the repository at this point in the history
… guidelines. (#116)

* [Documentation]: Add CONTRIBUTING.md to ease and explain contribution guidelines

* Update CONTRIBUTING.md with lenient commit rules
  • Loading branch information
pathange-s authored Mar 15, 2022
1 parent c28d0d9 commit 2e384a2
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit 2e384a2

Please sign in to comment.