2.2 KiB
Contributing to uwufetch
Code
To contribute to this project, you should follow some rules to keep the code consistent:
- Please try to be consistent in code formatting, if you use
Prettier, this are the rules used in all the files:
{
"arrowParens": "avoid",
"bracketSpacing": true,
"endOfLine": "lf",
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"jsxBracketSameLine": false,
"jsxSingleQuote": false,
"printWidth": 80,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": true,
"singleQuote": false,
"tabWidth": 4,
"trailingComma": "es5",
"useTabs": true,
"vueIndentScriptAndStyle": false
}
- Function and variable names should be written in snake_case and abbreviated if too long.
- Use shell commands only if necessary, just to improve
uwufetchspeed.
Pull requests
Before sending a pull request be sure that no one is already working on the same thing and to follow this guide-lines. Please add any external dependancies in the README.md.
With pull requests you can [FIX] a bug (reported or not), add [OS-SUPPORT], add a [NEW-FEATURE] requested in an issue, fix a [TYPO] or [OPTIMIZE] the code. For everything else do not use tags.
Issues
You can use the issues to report bugs with [BUG], to request features [FEATURE-REQUEST], to request support for an os [OS-SUPPORT]. For everything else do not use tags.
If you are reporting a [BUG], please include a screenshot and the output of the command (if a command is used in uwufetch).
If you are requesting a feature, please specify if you are already working on it, then send a pull request.
Conclusions
I know that adding this file now is a bit late, but I am writing this anyway, just to appear as a professional programmer, even though I am not.
I woult take some space to thank all the contributors that made this project better every day.