-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
512 additions
and
1 deletion.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @4r7if3x |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
name: '🐞 Bug Report' | ||
description: File a bug report | ||
title: '🐞 [BUG]: ' | ||
labels: ['malfunction', 'triage'] | ||
assignees: | ||
- 4r7if3x | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Your diligent report makes a difference! Your input help us identify and address malfunctions in our product. | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: Version | ||
description: What version of our software are you running? | ||
options: [ | ||
'0.1.0' | ||
] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: What's the problem? | ||
description: Please tell us what did you expect to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Relevant screenshots | ||
placeholder: | | ||
![](https://i.imgur.com/screenshot_1.png) | ||
![](https://i.imgur.com/screenshot_2.png) | ||
![](https://i.imgur.com/screenshot_3.png) | ||
... | ||
description: 'Please [upload](https://imgur.com/upload) any relevant screenshots and embed them here.' | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: 'Before submitting this issue, you must read our [Code of Conduct](https://github.com/coravel-rs/.github/blob/main/docs/CODE_OF_CONDUCT.md).' | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: '❓ Discussion Board' | ||
url: https://github.com/bilbilak/treegen/discussions/categories/q-a | ||
about: Ask your questions here | ||
- name: '📢 Support Policy' | ||
url: https://github.com/bilbilak/treegen/blob/main/docs/SUPPORT.md | ||
about: Learn how to get help here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: '💡 Feature Request' | ||
description: Suggest a new feature | ||
title: '💡 [NFR]: ' | ||
labels: ['enhancement'] | ||
assignees: | ||
- 4r7if3x | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Your innovative ideas matter to us! Your input help us expand and enrich our project with new features. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: What's your idea? | ||
description: Please tell us about what's on your mind. | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: 'Before submitting this issue, you must read our [Code of Conduct](https://github.com/coravel-rs/.github/blob/main/docs/CODE_OF_CONDUCT.md).' | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: '✨ Improvement Request' | ||
description: Propose a possible improvement | ||
title: '✨ [PIR]: ' | ||
labels: ['improvement'] | ||
assignees: | ||
- 4r7if3x | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Your invaluable contribution is appreciated! Your input help us improve our existing features or processes. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: What's your proposal? | ||
description: Please explain in detail how we can make this improvement. | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: 'Before submitting this issue, you must read our [Code of Conduct](https://github.com/coravel-rs/.github/blob/main/docs/CODE_OF_CONDUCT.md).' | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,47 @@ | ||
# treegen | ||
<p align="center"> | ||
<a href="#"> | ||
<img height="100" src="https://raw.githubusercontent.com/bilbilak/treegen/main/.github/assets/treegen-icon.png" alt="Icon"> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
ASCII Tree to Directory and File Structure Generator | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/bilbilak/treegen/releases/latest"> | ||
<img src="https://img.shields.io/github/v/release/bilbilak/treegen?include_prereleases&sort=semver&display_name=tag&style=flat-square&color=blue" alt="Latest Release"></a> | ||
<a href="https://en.wikipedia.org/wiki/Free_and_open-source_software"> | ||
<img src="https://img.shields.io/badge/type-FOSS-3da639?style=flat-square" alt="Type: FOSS"></a> | ||
<a href="https://github.com/bilbilak/treegen/blob/main/LICENSE.md"> | ||
<img src="https://img.shields.io/badge/license-GPL--3.0-be0000?style=flat-square" alt="License: GPLv3"></a> | ||
<br> | ||
<a href="https://www.reddit.com/r/bilbilak"> | ||
<img src="https://img.shields.io/badge/Reddit-r%2Fbilbilak-ff4500?logo=reddit&style=flat-square" alt="Reddit: r/bilbilak"></a> | ||
<a href="https://discord.gg/zAZATWqVmK"> | ||
<img src="https://img.shields.io/badge/Discord-Bilbilak-5865f2?logo=discord&style=flat-square" alt="Discord: Bilbilak"></a> | ||
<a href="https://matrix.to/#/#bilbilak:matrix.org"> | ||
<img src="https://img.shields.io/badge/Matrix-%23bilbilak-000000?logo=matrix&style=flat-square" alt="Matrix: #bilbilak"></a> | ||
</p> | ||
|
||
## 📖 About TreeGen | ||
|
||
**_TreeGen_** is a powerful Command Line Interface (CLI) tool designed to simplify the process of creating complex directory structures. It allows users to generate an entire file and folder structure from an ASCII tree representation. This can be incredibly useful for quickly setting up projects or replicating folder structures. | ||
|
||
## 👥 Support | ||
|
||
If you need assistance or have any questions regarding **_TreeGen_**, please refer to the [Support Policy](https://github.com/bilbilak/treegen/blob/main/docs/SUPPORT.md) for information on how to get help. We also welcome suggestions and ideas for new features or improvements. | ||
|
||
## 🤝 Contributing | ||
|
||
We encourage contributions from the community to help improve **_TreeGen_** and keep the project moving forward. If you're interested in contributing, please refer to the [Contribution Guide](https://github.com/bilbilak/treegen/blob/main/docs/CONTRIBUTING.md) for guidelines on how to participate in this project. | ||
|
||
## ⚖️ License | ||
|
||
> Copyright © 2024 [The Artifex (4r7if3x)](https://github.com/4r7if3x) | ||
**_TreeGen_** is distributed under the terms of the [GNU General Public License version 3](https://github.com/bilbilak/treegen/blob/main/LICENSE.md). Unless it is explicitly stated otherwise, any contribution intentionally submitted for inclusion in this project shall be licensed as _GPLv3_, without any additional terms or conditions. | ||
|
||
## 🛡️ Trademark | ||
|
||
The name of this project, **TreeGen™**, and its associated logo are subject to trademark rights. Despite the open-source nature of the project, these rights apply—even if the trademark is not registered. If you wish to reference this name or employ the associated branding elements, please refer to our [Brand Guidelines](https://github.com/bilbilak/treegen/blob/main/docs/BRAND_GUIDELINES.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Brand Guidelines | ||
|
||
Welcome to the Brand Guidelines for **TreeGen™**. This document provides an overview of our brand identity, and outlines how to use our brand assets, including our logo, colors, typography, and other visual elements. Following these guidelines will help to maintain the strength and consistency of our brand across all media and platforms. | ||
|
||
<br> | ||
|
||
If you have any questions or need further guidance, please contact our brand team at [media@bilbilak.dev](mailto:media@bilbilak.dev) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contribution Guide | ||
|
||
We appreciate your interest in contributing to this project! This document outlines the process for submitting code, documentation, or other types of contributions. Please read and follow these guidelines to ensure a smooth collaboration with the project maintainers. | ||
|
||
Before participating in the project, please read our [Code of Conduct](https://github.com/bilbilak/treegen?tab=coc-ov-file#readme). By engaging with this repository and its respective community, you agree to abide by its terms. | ||
|
||
## 💻 Setting up your development environment | ||
|
||
1. [Fork](https://github.com/bilbilak/treegen/fork) the project on _GitHub_ to your own account. | ||
- If you are new to forking repositories, you can find a detailed guide on forking [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
2. Clone your fork to your local development environment: | ||
``` | ||
git clone git@github.com:bilbilak/treegen.git | ||
cd bilbilak | ||
``` | ||
3. Make sure you have the necessary tools installed, such as _Go_ and any dependencies required by the project. | ||
|
||
**NOTE:** If you'd like to contribute to our documentation, please use [MyRepos](https://myrepos.branchable.com) tool to clone the project's _Wiki_. You can initiate the clone by running `mr checkout` as configured in the `.mrconfig` file. This will create the sub-repository under the `docs/wiki/` directory, separate from the main repository. To interact with this sub-repository, it's important to familiarize yourself with other `mr` commands. | ||
|
||
## 📐 Coding conventions and best practices | ||
|
||
When contributing to this project, please adhere to the following guidelines: | ||
|
||
... | ||
|
||
## 📤 Submitting your contribution | ||
|
||
1. Create a new branch for your contribution: | ||
``` | ||
git checkout -b feature/your-feature | ||
``` | ||
2. Make your changes and commit them with a descriptive message: | ||
``` | ||
git add . | ||
git commit -m "Add a brief description of your changes" | ||
``` | ||
- Writing clear and concise commit messages is important. For tips on how to write good commit messages, you can refer to [this guide](https://chris.beams.io/posts/git-commit/) tailored for projects following the _Gitflow_ approach. | ||
3. Push your changes to your fork on _GitHub_: | ||
``` | ||
git push origin feature/your-feature | ||
``` | ||
4. Create a pull request on the project's _GitHub_ repository, comparing the project's `develop` branch with your feature branch. | ||
5. Fill out the pull request template with a description of your changes, and reference any relevant issues or discussions. | ||
|
||
## 🧐 Review process | ||
|
||
After submitting your pull request, the project maintainers will review your contribution. They may request changes or provide feedback before merging your changes into the development branch. Please be patient and address any comments or concerns raised by the maintainers. | ||
|
||
<br> | ||
|
||
💖 Thank you for your contribution! Your collaboration helps improve the project for everyone. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Support Policy | ||
|
||
We're happy to help you with any questions or issues you may have regarding our project. This document outlines the various channels through which you can seek support and guidance. | ||
|
||
To ensure a welcoming and inclusive environment for all participants, we expect everyone to adhere to our [Code of Conduct](https://github.com/bilbilak/treegen?tab=coc-ov-file#readme) when interacting with our community. | ||
|
||
## 📚 Documentation | ||
|
||
For detailed information on **_TreeGen_** installation and usage instructions, please refer to the project's [Wiki](https://github.com/bilbilak/treegen/wiki). The Wiki provides comprehensive guides and resources to help you get started with **_TreeGen_** and make the most out of its features. Additionally, you can find answers to the most frequently asked questions (FAQs) in the Wiki. | ||
|
||
## ❓ Questions and Answers (Q&A) | ||
|
||
For general questions and discussions, please use the [Discussion Board](https://github.com/bilbilak/treegen/discussions/categories/q-a) of the project. This platform allows you to engage in conversations with the maintainers and other contributors, to ask your questions and participate in the polls. | ||
|
||
For an alternative and more engaging environment, join our [subreddit](https://www.reddit.com/r/bilbilak) to ask questions, share your experiences, and connect with other users in a community-driven atmosphere. | ||
|
||
|
||
### Asking Quality Questions | ||
|
||
Before asking a new question, please search for similar topics on _Google_, _Reddit_, _Stack Overflow_, or _GitHub_ to see if your question has already been addressed. | ||
|
||
When seeking help or asking questions, it's essential to provide clear and concise information. This enables the community to understand your issue and provide more accurate and helpful answers. The more time you put into asking your question, the better we can help you. Keep the following points in mind when asking questions: | ||
|
||
- Provide context and be specific about the problem you are facing. | ||
- Share relevant code snippets, logs, or error messages. | ||
- Consider creating a [Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) to illustrate your issue. | ||
- Be aware of the [XY Problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378) and ensure you're asking about your actual issue, rather than a potential solution you've considered. | ||
|
||
Before posting your question, try [Talking to a Duck](https://rubberduckdebugging.com)! Sometimes, explaining the problem to someone else can help you find the solution on your own. | ||
|
||
## 💬 Chat Rooms | ||
|
||
For instant messaging and real-time collaboration, [join](https://discord.gg/zAZATWqVmK) our dynamic _Discord_ community. You can ask questions, share your thoughts, and interact with other members. | ||
|
||
Some users appreciate Matrix for its enhanced privacy and resilience. To connect with like-minded members, [join](https://matrix.to/#/#bilbilak:matrix.org) the `#bilbilak` space on the main homeserver. | ||
|
||
## 🚩 Submitting Issues | ||
|
||
If you encounter any bugs to report, want to request new features, or suggest improvements, please open an [Issue](https://github.com/bilbilak/treegen/issues) on the project's _GitHub_ repository. Please use the appropriate issue templates to ensure your submission contains all the necessary information. | ||
|
||
When submitting an issue, please provide as much information as possible, including steps to reproduce the problem and any relevant context. This will help us understand and address your concerns more effectively. | ||
|
||
**NOTE:** If you discover a security vulnerability within the project, please do not report it through the public issue tracker. Instead, report it privately in accordance with our [Security Policy](https://github.com/bilbilak/treegen?tab=security-ov-file#readme). | ||
|
||
<br> | ||
|
||
💖 Thank you for being a part of our community! We appreciate your support and collaboration. |