mirror of
https://github.com/allthingslinux/tux.git
synced 2024-10-02 16:43:12 +00:00
8fcebd00be
refactor(CONTRIBUTING.md): improve document structure and readability by adding indentation and spacing style(CONTRIBUTING.md): add newline at end of file to adhere to POSIX standards feat: add .markdownlint.yaml for consistent markdown formatting This commit adds a .markdownlint.yaml configuration file to enforce consistent markdown formatting across the project. This will help maintain readability and uniformity in all markdown files. docs: improve readability and clarity of project documentation - README.md: Simplify title and subtitle formatting, add warning about bot readiness, clarify installation steps, and improve overall readability. - cli.md: Improve readability by adding line breaks. - commands.md: Remove unnecessary line break. - development.md: Simplify introduction, refer to README for installation instructions, and improve readability. - permissions.md: Improve readability by adding line breaks and clarifying permission levels. style(services.md): improve readability by adding a line break between two sentences docs(services.md): add newline at end of file to adhere to POSIX standards
1.5 KiB
1.5 KiB
Contributing to Tux 🐧
Topics
Contributing Flow
-
See Issues topic.
-
Fork the project.
-
Create a new branch (please, see Branch Naming Conventions topic if you don't know our conventions).
-
After done with modifications, time to commit and push. Example:
git add tux/help.py git commit -m "feat(tux): add help command" -m "Help command description" git push origin feat/add-help-command
-
Send a Pull Request (PR) with the modifications, referencing the
main
branch. -
Your contribution will be reviewed by the maintainers.
After merge:
- Delete the branch used to commit:
git checkout main
git push origin --delete feat/add-help-command
git branch -D feat/add-help-command
- Update your fork:
git remote add upstream https://github.com/allthingslinux/tux.git
git fetch upstream
git rebase upstream/main
git push -f origin main
Issues
Before submitting a large PR, please open an issue so we can discuss the idea.
Branch Naming Conventions
- Documentation:
git checkout -b docs/contributing
- Modifications:
git checkout -b chore/update-dependencies
- Features:
git checkout -b feat/add-help-command
- Fixing:
git checkout -b fix/help-command