Skip to content

Sending a Pull Request

Mojtaba edited this page Aug 29, 2022 · 1 revision

This document is about guides and rules to create a pull request on NodCMS.

The Open Source Guide is a good first read for those new to contributing to open source!

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

NodCMS overview

NodCMS build for end user. It should work just fine for all interested parties, even if they cannot write a single word in config files. We are trying to keep it developer- and user-friendly.

NodCMS is based on CodeIgniter. NodCMS is based on CodeIgniter. Which means we follow them, learn from them, and try to solve things like they are.

NodCMS want to be grown. Right now we are very small group. We are trying to automate many process that possible to get things done faster and easier.

We follow the PSR-12: Extended Coding Style convention.

Acceptable pull requests

  • Changes should be small enough, that we could understand it.
  • Pull requests description should be clear and understandable.
  • The changes on pull requests should be listed in the change log under [Unreleased] tag.