Skip to content

Commit

Permalink
Add markdown-lint check - and fix issues (#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor authored Oct 6, 2024
1 parent b54d9e2 commit 4a7abcb
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 37 deletions.
11 changes: 10 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,17 @@ on:
- master
workflow_dispatch:
jobs:
Awesome_Lint:
awesome-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: npx awesome-lint
markdown-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: markdown-lint
uses: DavidAnson/markdownlint-cli2-action@v17
with:
globs: |
**/*.md
8 changes: 8 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
default: true

# Allow arbitrary line length
#
# Reason: We apply the one-sentence-per-line rule. A sentence may get longer than 80 characters, especially if links are contained.
#
# Details: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
MD013: false
6 changes: 6 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"recommendations": [
"davidanson.vscode-markdownlint",
"ltex-plus.vscode-ltex-plus"
]
}
1 change: 1 addition & 0 deletions .vscode/ltex.disabledRules.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
UPPERCASE_SENTENCE_START
54 changes: 19 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,31 +39,31 @@ Here, you find possibilities to ease the search.

- Use [Search Engine Hacktoberfest Project Finder](https://hacktoberfest-projects.vercel.app/) - Offers filtering by language. The best thing is that the projects are initially sorted by GitHub stars.
- Use [Search Engine Up For Grabs](https://up-for-grabs.net/#/) - find beginner-friendly projects and issues
- [Search for label hacktoberfest](https://github.com/search?q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue) - Label especially created for hacktoberfest.
- [Search for label first-timers-only](https://github.com/search?q=label%3Afirst-timers-only+state%3Aopen+type%3Aissue)
- [Search for label for-new-contributors](https://github.com/search?q=label%3Afor-new-contributors+state%3Aopen+type%3Aissue)
- [Search for label good-first-issue](https://github.com/search?q=label%3Agood-first-issue+state%3Aopen+type%3Aissue)
- [Search for label easy](https://github.com/search?q=label%3Aeasy)
- [Search for label `hacktoberfest`](https://github.com/search?q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue) - Label especially created for Hacktoberfest.
- [Search for label `first-timers-only`](https://github.com/search?q=label%3Afirst-timers-only+state%3Aopen+type%3Aissue)
- [Search for label `for-new-contributors`](https://github.com/search?q=label%3Afor-new-contributors+state%3Aopen+type%3Aissue)
- [Search for label `good-first-issue`](https://github.com/search?q=label%3Agood-first-issue+state%3Aopen+type%3Aissue)
- [Search for label `easy`](https://github.com/search?q=label%3Aeasy)

## Events

- <https://hacktoberfest.com/events/> - List of all hacktoberfest events.
- <https://hacktoberfest.com/events/> - List of all Hacktoberfest events.

## Projects friendly to Hacktoberfest 1st time contributors

In case you are an experienced developer, projects have prepared special issues for hacktoberfest.
In case you are an experienced developer, projects have prepared special issues for Hacktoberfest.
Below you will find awesome projects that have been put notable efforts into Hacktoberfest.
They also try to be very welcoming for 1st-time contributors.

### CSS

([all CSS projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=CSS))
([all CSS projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=CSS))

- [crystal-ann](https://github.com/crystal-community/crystal-ann)

### Dart / Flutter

([all dart projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ADart&type=Issues&ref=advsearch&l=Dart&l=))
([all dart projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ADart&type=Issues&ref=advsearch&l=Dart&l=))

- [The Public Transport](https://github.com/thepublictransport/thepublictransport-app)

Expand All @@ -78,41 +78,39 @@ They also try to be very welcoming for 1st-time contributors.

### HTML

([all HTML projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=HTML))
([all HTML projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=HTML))

### JavaScript

([all JavaScript projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=JavaScript))
([all JavaScript projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=JavaScript))

- [jest-extended](https://github.com/mattphillips/jest-extended)
- [letra-extension](https://github.com/jayehernandez/letra-extension) - Passively learn a new language every time you open a new tab.
- [vue-dropzone](https://github.com/rowanwins/vue-dropzone)

### Java

([all Java projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=Java&l=))
([all Java projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3AJava&type=Issues&ref=advsearch&l=Java&l=))

### PHP

([all PHP projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3APHP&type=Issues&ref=advsearch&l=&l=))

- [hacktoberfest-status](https://github.com/niclasleonbock/hacktoberfest-status)
([all PHP projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3APHP&type=Issues&ref=advsearch&l=&l=))

### Python

([all python projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3APython&type=Issues&ref=advsearch&l=Dart&l=))
([all python projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3APython&type=Issues&ref=advsearch&l=Dart&l=))

- [django-gamification](https://github.com/mattjegan/django-gamification)
- [howlong](https://github.com/mattjegan/HowLong)
- [python-ds](https://github.com/prabhupant/python-ds) - Datastructures implemented in Python.
- [python-ds](https://github.com/prabhupant/python-ds) - Data structures implemented in Python.
- [quick-net](https://github.com/Zwork101/quick-net)
- [Ralph](https://github.com/allegro/ralph)
- [Tipboard](https://github.com/allegro/tipboard)
- [wtfuzz](https://github.com/mattjegan/wtfuzz)

### React

([all React projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ADart&type=Issues&ref=advsearch&l=React&l=))
([all React projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ADart&type=Issues&ref=advsearch&l=React&l=))

- [Blitz](https://github.com/blitz-js/blitz) - Blitz is a batteries-included framework that's inspired by Ruby on Rails, is built on Next.js, and features a "Zero-API" data layer abstraction that eliminates the need for REST/GraphQL.
- [Gatsby](https://github.com/gatsbyjs/gatsby) - Gatsby is a free and open source framework for building blazing fast static websites.
Expand All @@ -124,27 +122,14 @@ They also try to be very welcoming for 1st-time contributors.

### TypeScript

([all TypeScript projects with hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ATypescript&type=Issues&ref=advsearch&l=Typescript))
([all TypeScript projects with Hacktoberfest issues](https://github.com/search?utf8=%E2%9C%93&q=label%3Ahacktoberfest+state%3Aopen+type%3Aissue+language%3ATypescript&type=Issues&ref=advsearch&l=Typescript))

- [LitmusChaos](https://github.com/litmuschaos/litmus/issues?q=is%3Aissue+is%3Aopen+label%3AHacktoberfest)

## Companies participating in Hacktoberfest

- [Accord](https://www.accordproject.org/events/hacktoberfest-2019/)
- [Amplication](https://www.github.com/amplication/amplication)
- [Appsmith](https://hacktoberfest.appsmith.com/)
- [Appwrite](https://medium.com/appwrite-io/hacktoberfest-2019-is-almost-here-lets-celebrate-it-together-24b311236dd)
- [Circle CI](https://circleci-public.github.io/hacktoberfest/#/)
- [Coding Blocks](https://blog.codingblocks.com/2019/cb-hacktoberfest-2019/)
- [Devfolio](https://devfolio.co/blog/hacktoberfest-2019-devfolio/)
- [Gatsby](https://github.com/gatsbyjs/store.gatsbyjs.org)
- [Globol](https://hacktoberfest.globo.com/)
- [Grafana Labs](https://github.com/grafana/grafana)
- [Hasura](https://blog.hasura.io/hasura-joins-hacktoberfest-2019/)
- [JetBrains](https://www.jetbrains.com/lp/hacktoberfest-2020/) - JetBrains offers a wide range of developer IDEs. For Hacktoberfest, it makes them available for free for open source contributors independently of the contributor being a permanent contributor to an open source project (which is covered by their Free Licenses Program).
- [MayaData](https://blog.mayadata.io/celebrate-hacktoberfest-2020-open-source-with-mayadata)
- [Medusa Hackathon](https://medusajs.com/blog/medusa-hackathon/)
- [Sendgrid](https://sendgrid.com/blog/hacktoberfest-2018-hack-on-sendgrid-open-source-projects/)
- [WildFly](https://www.wildfly.org/news/2024/09/23/Hacktoberfest-2024/)

## Nonprofits participating in Hacktoberfest

Expand All @@ -154,12 +139,11 @@ They also try to be very welcoming for 1st-time contributors.
## Misc resources

- [AwesomeSearch](https://awesomelists.top/) - Search engine for [the awesome list](https://awesome.re) providing useful programming resources.
- [Track Awesome List Updates Daily](https://www.trackawesomelist.com/) - Lists updates of awesme lists.
- [Track Awesome List Updates Daily](https://www.trackawesomelist.com/) - Lists updates of awesome lists.
- [First Timers Only](https://www.firsttimersonly.com/) - Page highlighting awesome facts on first-time contributions.

## Other awesome lists

- [Awesome Hacktoberfest 2022](https://github.com/OtacilioN/awesome-hacktoberfest-2022) - Lists awesome projects categorized for beginners and advanced coders for Hacktoberfest 2022.
- [Awesome First PR Opportunities](https://github.com/MunGell/awesome-for-beginners) - Lists projects which are beginner-friendly.
- [The Top Open Source Projects marked for Hacktoberfest](https://awesomeopensource.com/projects/hacktoberfest) - List of 29,980 projects on GitHub.

Expand Down
2 changes: 1 addition & 1 deletion code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing or otherwise, unacceptable behaviour may be
reported by contacting the project team at matthewj.egan@hotmail.com. All
reported by contacting the project team at <matthewj.egan@hotmail.com>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality concerning the reporter of an incident.
Expand Down

0 comments on commit 4a7abcb

Please sign in to comment.