rideaware/project-template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
3 commits 1 branch 0 tags 45 KiB
Find a file
Exact
Blake Ridgway 8611afa3f0 docs: add commit message guidelines 
Establish a formal convention for Git commit messages to improve the
clarity and readability of the project's history.

This standard follows the Conventional Commits specification and will
enable potential future automation for changelog generation.
2025-06-11 20:54:43 -05:00
.idea fix: removed .idea folder 2025-06-11 20:51:18 -05:00
.gitignore feat: Add gitignore template 2025-06-11 20:50:20 -05:00
CHANGELOG.md feat: Add gitignore template 2025-06-11 20:50:20 -05:00
CODE_OF_CONDUCT.md feat: Add gitignore template 2025-06-11 20:50:20 -05:00
CONTRIBUTING.md docs: add commit message guidelines 2025-06-11 20:54:43 -05:00
LICENSE feat: Add gitignore template 2025-06-11 20:50:20 -05:00
README.md feat: Add gitignore template 2025-06-11 20:50:20 -05:00

README.md

[Project Title]

[One-line description of what this project does.]

GitLab Pipeline Status License: AGPL v3

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

Built With:

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://gitlab.com/rideaware/[repo-name].git
  2. Install NPM packages 
    npm install

Usage

import { awesomeFeature } from "rideaware-project";

const result = awesomeFeature();
console.log(result);

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please read our CONTRIBUTING.md for details on our code of conduct, and the process for submitting merge requests to us.

License

Distributed under the GNU AGPLv3 License. See LICENSE for more information.

Contact

Blake - blake@rideaware.org

Project Link: https://gitlab.com/rideaware/[repo-name]