Skip to content

Commit

Permalink
remove contributing guidelines duplicate
Browse files Browse the repository at this point in the history
`docs/contributing.md` is now auto generated
  • Loading branch information
adamperkowski committed Oct 8, 2024
1 parent 49379a7 commit 8688867
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 64 deletions.
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- docs/contributing.md IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->

# Contributing Guidelines for Linutil

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
Expand Down
4 changes: 2 additions & 2 deletions .github/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav:
- Introduction: 'index.md'
- User Guide: 'userguide.md'
- Contributing:
- Contributing Guide: 'contribute.md'
- Contributing Guide: 'contributing.md'
- Roadmap: 'roadmap.md'
- Documentation:
- Known Issues: 'KnownIssues.md'
Expand Down Expand Up @@ -86,4 +86,4 @@ plugins:
minify_html: true
htmlmin_opts:
remove_comments: true
cache_safe: true
cache_safe: true
10 changes: 10 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ jobs:
with:
fetch-depth: '0' # Fetch all commit history for all branches as well as tags.

- name: Copy Contributing Guidelines
run: cp '.github/CONTRIBUTING.md' 'docs/contributing.md'

- uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: Commit Contributing Guidelines
file_pattern: "docs/contributing.md"
add_options: '--force'
if: success()

- name: Setup Python
uses: actions/setup-python@v5
with:
Expand Down
62 changes: 0 additions & 62 deletions docs/contribute.md

This file was deleted.

0 comments on commit 8688867

Please sign in to comment.