├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ └── add-dots.yml ├── scripts │ └── auto-add-dotfile.mjs └── workflows │ └── convert.yml ├── assets └── reddit.svg ├── CONTRIBUTING.md ├── code-of-conduct.md ├── LICENCE └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: 0pandadev -------------------------------------------------------------------------------- /assets/reddit.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing Guidelines 2 | 3 | Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project, you agree to abide by its terms. 4 | 5 | ## Table of Contents 6 | 7 | - [Pull Request Guidelines](#pull-request-guidelines) 8 | - [How to add to this list](#how-to-add-to-this-list) 9 | - [Updating your Pull Request](#updating-your-pull-request) 10 | 11 | ## Pull Request Guidelines 12 | 13 | Please ensure your pull request adheres to the following guidelines: 14 | 15 | - Search previous suggestions to make sure your suggestion isn't a duplicate. 16 | - Make sure each list item is useful before adding it. 17 | - Create individual pull requests/issues for each suggestion. 18 | - Use the following format: `- [Github Username](dotfiles-repo-link) - Description [![reddit][reddit]](link-to-reddit-post)` 19 | - Link additions should be added in alphabetical order in the relevant category. 20 | - New categories or changes to the existing categorization are welcome. 21 | - Check your spelling and grammar. 22 | - Make sure your text editor is set to remove trailing whitespace. 23 | - The pull request and commit should have a useful title. 24 | - Annotate your PR to clarify what you did if the diff is confusing. 25 | 26 | Thank you for your suggestions! 27 | 28 | ## How to add to this list 29 | 30 | Either make an issue with the template Add Application, which will then automatically create a pull request, or make your manual changes as follows: 31 | 32 | If you don't have a [GitHub account](https://github.com/join), make one! 33 | 34 | 1. Fork this repo. 35 | 2. Make changes under correct section in `README.md` 36 | 3. Update `Contents` (if applicable) 37 | 4. Commit and open a Pull Request 38 | 39 | ## Updating your Pull Request 40 | 41 | Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-dotfiles list guidelines. 42 | 43 | [Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that. 44 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/add-dots.yml: -------------------------------------------------------------------------------- 1 | name: Add Dotfiles 2 | description: Add a dotfiles repo to the list 3 | labels: ["Add"] 4 | title: "[ADD] " 5 | assignees: 6 | - 0pandadev 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thanks for taking the time to suggest a dotfiles repo! 12 | Please fill out the form below to provide details about the dotfiles repo. 13 | 14 | - type: input 15 | id: dotfiles-url 16 | attributes: 17 | label: Dotfiles URL 18 | description: Provide the URL to the dotfiles repo 19 | placeholder: https://github.com/username/dotfiles 20 | validations: 21 | required: true 22 | 23 | - type: dropdown 24 | id: app-category 25 | attributes: 26 | label: DE or WM 27 | description: Which Desktop Environment or Window Manager does this dotfiles repo use? 28 | options: 29 | - dwm 30 | - Gnome 31 | - Hyprland 32 | - KDE 33 | - maomaowm 34 | - Niri 35 | - Sway 36 | - Yabai 37 | - i3 38 | - bspwm 39 | - AwesomeWM 40 | - Qtile 41 | - XFCE 42 | - Cinnamon 43 | - MATE 44 | - Budgie 45 | - LXQt 46 | - Openbox 47 | - Xmonad 48 | - Herbstluftwm 49 | - LeftWM 50 | - StumpWM 51 | - Spectrwm 52 | - DWL 53 | - River 54 | validations: 55 | required: true 56 | 57 | - type: input 58 | id: dotfiles-tagline 59 | attributes: 60 | label: Tagline 61 | description: A one sentence tagline for the dotfiles preferably the same as the r/unixporn reddit post title. 62 | validations: 63 | required: true 64 | 65 | - type: input 66 | id: reddit-url 67 | attributes: 68 | label: Reddit URL (optional) 69 | description: Provide the URL to the r/unixporn reddit post 70 | placeholder: https://www.reddit.com/r/unixporn/... 71 | validations: 72 | required: false 73 | 74 | - type: textarea 75 | id: image 76 | attributes: 77 | label: Preview Image 78 | description: Paste an image here. 79 | placeholder: It should look like this ![Image](https://github.com/user-attachments/assets/84884a94-7a7b-4b43-854b-f2a6a88d00a1) 80 | validations: 81 | required: true 82 | 83 | - type: checkboxes 84 | id: auto-convert 85 | attributes: 86 | label: Automatically Add to list 87 | description: If this is checked the issue will be converted to a PR in your name and automatically added to the list. 88 | options: 89 | - label: I want to automatically add it 90 | required: false 91 | 92 | - type: checkboxes 93 | id: terms 94 | attributes: 95 | label: Code of Conduct 96 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/0pandadev/awesome-dotfiles/blob/main/code-of-conduct.md) 97 | options: 98 | - label: I agree to follow this project's Code of Conduct 99 | required: true 100 | -------------------------------------------------------------------------------- /code-of-conduct.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as physical or electronic 30 | address, without explicit permission 31 | * Other conduct that could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at . All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [https://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: https://contributor-covenant.org 74 | [version]: https://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /.github/scripts/auto-add-dotfile.mjs: -------------------------------------------------------------------------------- 1 | import { readFile, writeFile } from "fs/promises"; 2 | 3 | let issueRaw = ""; 4 | for await (const chunk of process.stdin) { 5 | issueRaw += chunk; 6 | } 7 | 8 | const issue = JSON.parse(issueRaw); 9 | const issueNumber = issue.number; 10 | 11 | const getField = (id) => { 12 | const patterns = [ 13 | new RegExp( 14 | `(?:^|\\n)\\s*### ${id.replace( 15 | /[-]/g, 16 | "[-]", 17 | )}\\n([\\s\\S]*?)(?=\\n### |$)`, 18 | "i", 19 | ), 20 | new RegExp( 21 | `### ${id.replace(/[-]/g, "[-]")}\\n([\\s\\S]*?)(?=\\n### |$)`, 22 | "i", 23 | ), 24 | ]; 25 | 26 | for (const pattern of patterns) { 27 | const match = issue.body.match(pattern); 28 | if (match) { 29 | const result = match[1].trim(); 30 | console.log(`Found ${id}: "${result}"`); 31 | return result; 32 | } 33 | } 34 | 35 | console.log(`Field "${id}" not found in issue body`); 36 | return ""; 37 | }; 38 | 39 | const getCheckbox = (id, label) => { 40 | const re = new RegExp(`- \\[([ xX])\\] ${label}`); 41 | const f = issue.body.match(re); 42 | return f && f[1] !== " " ? true : false; 43 | }; 44 | 45 | const findInsertionPoint = (sectionContent, username) => { 46 | const tableRegex = /[\s\S]*?<\/table>/g; 47 | const tables = sectionContent.match(tableRegex) || []; 48 | 49 | const existingEntries = tables 50 | .map((table) => { 51 | const usernameMatch = table.match(/([^<]+)<\/a>/); 52 | return usernameMatch ? usernameMatch[1] : ""; 53 | }) 54 | .filter((name) => name); 55 | 56 | let insertionIndex = 0; 57 | for (let i = 0; i < existingEntries.length; i++) { 58 | if (username.toLowerCase() < existingEntries[i].toLowerCase()) { 59 | insertionIndex = i; 60 | break; 61 | } 62 | insertionIndex = i + 1; 63 | } 64 | 65 | return { insertionIndex, totalEntries: existingEntries.length }; 66 | }; 67 | 68 | const autoConvertChecked = getCheckbox( 69 | "auto-convert", 70 | "I want to automatically add it", 71 | ); 72 | if (!autoConvertChecked) process.exit(0); 73 | 74 | const dotfilesUrl = getField("Dotfiles URL"); 75 | const appCategory = getField("DE or WM"); 76 | const description = getField("Tagline"); 77 | const redditUrl = getField("Reddit URL \$optional\$"); 78 | const image = getField("Preview Image"); 79 | 80 | const username = dotfilesUrl 81 | .replace(/https:\/\/github.com\//, "") 82 | .split("/")[0]; 83 | const imgMatch = image.match(/!\[.*?\]$(.*?)$/); 84 | const imgUrl = imgMatch ? imgMatch[1] : ""; 85 | 86 | const section = appCategory.replace(/ /g, ""); 87 | const readmePath = "README.md"; 88 | const readme = await readFile(readmePath, "utf8"); 89 | const sectionHeader = `# ${section}`; 90 | const sectionIndex = readme.indexOf(sectionHeader); 91 | if (sectionIndex === -1) process.exit(1); 92 | const nextSection = readme.indexOf("# ", sectionIndex + 1); 93 | const sectionContent = readme.slice( 94 | sectionIndex, 95 | nextSection === -1 ? undefined : nextSection, 96 | ); 97 | const beforeSection = readme.slice(0, sectionIndex); 98 | const afterSection = nextSection === -1 ? "" : readme.slice(nextSection); 99 | 100 | const validRedditUrl = 101 | redditUrl && redditUrl !== "_No response_" ? redditUrl : "#"; 102 | const table = `