Initial commit

.github/workflows/gitleaks.yml

@@ -0,0 +1,18 @@
+name: gitleaks
+on: 
+    pull_request:
+    push:
+      branches:
+        - 'main'
+jobs:
+  scan:
+    name: gitleaks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}}

CODE_OF_CONDUCT.md

@@ -0,0 +1,60 @@
+# [Project Name] Code of Conduct
+
+## 1. Introduction
+
+The [Project Name] community is dedicated to providing a welcoming, inclusive, and harassment-free environment for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, nationality, religion, or technical experience. This Code of Conduct outlines our expectations for all members of the [Project Name] community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in [Project Name] to help us create a safe and positive environment for everyone.
+
+## 2. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+- Be respectful, considerate, and collaborative.
+- Refrain from demeaning, discriminatory, or harassing behavior and speech.
+- Be mindful of your surroundings and fellow participants.
+- Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 3. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+- Violence, threats of violence, or violent language directed against another person.
+- Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory jokes and language.
+- Posting or displaying sexually explicit or violent material.
+- Posting or threatening to post other people's personally identifying information ("doxing").
+- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Inappropriate photography or recording.
+- Inappropriate physical contact. You should have someone's consent before touching them.
+- Unwelcome sexual attention. This includes sexualized comments or jokes, inappropriate touching, groping, and unwelcome sexual advances.
+- Deliberate intimidation, stalking, or following (online or in-person).
+- Advocating for, or encouraging, any of the above behavior.
+
+## 4. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 5. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. You can contact the project maintainer at [[email protected]].
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 6. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the project maintainer with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+
+## 7. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
+
+## 8. Contact Information
+
+You can contact the project maintainer at [[email protected]].
+
+## 9. License and Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct/.

CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# CONTRIBUTING to [Your Project Name]
+
+First of all, thank you for considering to contribute to [Your Project Name]! Your help is invaluable to improve the project and make it more useful for the community. This document will guide you through the contribution process and make it easier for you to get started.
+
+## Table of Contents
+
+- [CONTRIBUTING to \[Your Project Name\]](#contributing-to-your-project-name)
+  - [Table of Contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [Getting Started](#getting-started)
+  - [How to Contribute](#how-to-contribute)
+    - [Reporting Bugs](#reporting-bugs)
+    - [Suggesting Enhancements](#suggesting-enhancements)
+    - [Pull Requests](#pull-requests)
+  - [Style Guide](#style-guide)
+  - [Additional Resources](#additional-resources)
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to ensure a welcoming and inclusive environment for all contributors.
+
+## Getting Started
+
+1. Fork the repository on GitHub.
+2. Clone your fork to your local machine.
+3. Create a new branch for your feature or bugfix.
+   1. Use `git checkout -b feature/your-feature-name` for features.
+   2. Use `git checkout -b bugfix/your-bugfix-name`) for bugfixes.
+4. Make your changes and commit them to your new branch.
+5. Push your changes to your fork.
+6. Open a pull request against the main branch of the original repository.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create a new issue in the [issue tracker](https://github.com/vechainfoundation/your_project_name/issues). When submitting a bug report, please include:
+
+- A clear and descriptive title.
+- A detailed description of the issue, including the steps to reproduce the bug.
+- Screenshots, if applicable, to help demonstrate the problem.
+- The version of the project you are using, as well as any other relevant information (e.g., operating system, browser, etc.).
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or improvement, please create a new issue in the [issue tracker](https://github.com/vechainfoundation/your_project_name/issues). When suggesting an enhancement, please include:
+
+- A clear and descriptive title.
+- A detailed description of the proposed feature, including examples of how it should work.
+- Any relevant use cases or benefits of the proposed enhancement.
+
+### Pull Requests
+
+If you would like to contribute code, documentation, or other assets to the project, please submit a pull request. When submitting a pull request, please:
+
+- Ensure that your code follows the [Style Guide](#style-guide).
+- Provide a clear and descriptive title.
+- Include a description of the changes you made and their purpose.
+- Reference any related issues or pull requests, if applicable.
+- Make sure your code passes any tests and linters that the project uses.
+- Update any relevant documentation or comments.
+
+## Style Guide
+
+Please adhere to the project's coding style and conventions when contributing. This may include:
+
+- Code formatting rules (e.g., indentation, line length, etc.).
+- Naming conventions for variables, functions, classes, etc.
+- Commenting guidelines, including when and how to write comments.
+- Test-writing guidelines, including test coverage requirements.
+
+If the project uses a specific code formatter or linter, please ensure your contributions pass these checks before submitting a pull request.
+
+## Additional Resources
+
+- [GitHub Help: Forking a repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
+- [GitHub Help: Creating a pull request from a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
+- [Git Branching and Merging](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging)
+
+Once again, thank you for your interest in contributing to [Your Project Name]! Your support and collaboration are crucial to the success and growth of this project. If you have any questions or need additional guidance, please don't hesitate to reach out to the maintainers.
+
+Happy coding!

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2018-2023 Vechain Foundation San Marino S.r.l.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,94 @@
+# Project Title
+
+![Your Project Logo](link-to-logo-image)
+
+## Introduction
+
+A brief description of your project, its purpose, and main features.
+
+This is a template repository, that allows you to quickly create new repos with the following templates:
+1. [README.md](/README.md)
+2. [CONTRIBUTING.md](/CONTRIBUTING.md)
+3. [CODE_OF_CONDUCT.md](/CODE_OF_CONDUCT.md)
+4. [LICENSE.md](/LICENSE.md)
+
+Consider turning on branch protection for `main` as follows:
+1. Require a pull request before merging.
+  1. Require 1 approval.
+  2. Dismiss stale pull request approvals when new commits are pushed.
+  3. Require review from Code Owners.
+  4. Require approval of the most recent reviewable push.
+2. Require status checks to pass before merging.
+3. Require branches to be up to date before merging.
+4. Require conversation resolution before merging.
+5. Require deployments to succeed before merging.
+
+## Table of Contents
+
+- [Project Title](#project-title)
+  - [Introduction](#introduction)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+    - [Configuration](#configuration)
+    - [Usage](#usage)
+    - [Documentation](#documentation)
+    - [Contributing](#contributing)
+    - [Roadmap](#roadmap)
+    - [Changelog](#changelog)
+    - [License](#license)
+    - [Credits](#credits)
+
+## Getting Started
+
+### Prerequisites
+
+List the required software, libraries, or tools needed to use or contribute to the project.
+
+### Installation
+
+Provide step-by-step instructions for installing the project, including any required dependencies.
+
+```bash
+# Example installation commands
+```
+
+### Configuration
+
+Explain how to configure the project, if necessary.
+
+### Usage
+
+Include code examples or usage instructions to help users get started quickly.
+
+### Documentation
+
+Link to any additional documentation or tutorials, either within your repository or hosted externally.
+
+### Contributing
+
+Explain how others can contribute to the project. Include information on:
+
+    How to submit bug reports or feature requests.
+    The process for submitting pull requests.
+    Any specific coding standards or guidelines.
+    The best way to get in touch with the maintainers, if needed.
+
+You may use [a separate `CONTRIBUTING` file](/CONTRIBUTING.md) to keep your `README.md` short.
+
+### Roadmap
+
+Share the project's development roadmap, if available, including planned features and improvements.
+
+### Changelog
+
+Keep a log of all notable changes and updates in the project.
+
+### License
+
+This project is licensed under the LICENSE-NAME - see [the LICENSE file](/LICENSE.md) for details.
+
+### Credits
+
+Recognize any significant contributors, sponsors, or organizations that have supported the project.