extern
/
christianlempa-boilerplates
mirror of https://github.com/ChristianLempa/boilerplates.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
christianlempa-boilerplates/CONTRIBUTING.md

29 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

docs: following `markdownlint` rules for consistency closes #75 Here is a list of rules that have been applied: - [MD009](https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md) - Trailing spaces - [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) - Headings should be surrounded by blank lines - [MD025](https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md) - Multiple top-level headings in the same document - [MD026](https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md) - Trailing punctuation in heading - [MD029](https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md) - Ordered list item prefix - [MD031](https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md) - Fenced code blocks should be surrounded by blank lines - [MD032](https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md) - Lists should be surrounded by blank lines - [MD034](https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md) - Bare URL used - [MD041](https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md) - First line in a file should be a top-level heading - [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) - Files should end with a single newline character docs: removal of duplicated links and improvements Furthermore, duplicated links to the Official Cert-Manager Documentation have been removed. Additionally, some files have been enhanced with improved titles and added short descriptions.
2023-06-01 08:28:09 +02:00
# Welcome to contributing at The Digital Life.🤝
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
- Products continuously change over time, specially those that are in high demand.
- Although I do my best to keep up with the latest changes and releases, but if you find something that needs to update, please contribute.
fix: update URLs in contributing document
2024-02-24 00:58:12 +01:00
- If you’d like to contribute to this project, reach out to me on social media or [Discord](https://christianlempa.de/discord), or create a pull request for the necessary changes.
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
## Project overview
fix: update URLs in contributing document
2024-02-24 00:58:12 +01:00
To get an overview of the project, read the [README](https://github.com/ChristianLempa/boilerplates#readme).
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
## Issues
### Create a new issue
docs: following `markdownlint` rules for consistency closes #75 Here is a list of rules that have been applied: - [MD009](https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md) - Trailing spaces - [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) - Headings should be surrounded by blank lines - [MD025](https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md) - Multiple top-level headings in the same document - [MD026](https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md) - Trailing punctuation in heading - [MD029](https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md) - Ordered list item prefix - [MD031](https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md) - Fenced code blocks should be surrounded by blank lines - [MD032](https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md) - Lists should be surrounded by blank lines - [MD034](https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md) - Bare URL used - [MD041](https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md) - First line in a file should be a top-level heading - [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) - Files should end with a single newline character docs: removal of duplicated links and improvements Furthermore, duplicated links to the Official Cert-Manager Documentation have been removed. Additionally, some files have been enhanced with improved titles and added short descriptions.
2023-06-01 08:28:09 +02:00
If you spot a problem with the templates, search if that issue already exists.
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
If a relevant issue doesn't exist, you can open a new issue in the issue's tab.
### Solve an issue
docs: following `markdownlint` rules for consistency closes #75 Here is a list of rules that have been applied: - [MD009](https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md) - Trailing spaces - [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) - Headings should be surrounded by blank lines - [MD025](https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md) - Multiple top-level headings in the same document - [MD026](https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md) - Trailing punctuation in heading - [MD029](https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md) - Ordered list item prefix - [MD031](https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md) - Fenced code blocks should be surrounded by blank lines - [MD032](https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md) - Lists should be surrounded by blank lines - [MD034](https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md) - Bare URL used - [MD041](https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md) - First line in a file should be a top-level heading - [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) - Files should end with a single newline character docs: removal of duplicated links and improvements Furthermore, duplicated links to the Official Cert-Manager Documentation have been removed. Additionally, some files have been enhanced with improved titles and added short descriptions.
2023-06-01 08:28:09 +02:00
Search through the existing issues to find one that interests you. You can refine the search using labels as filters.
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
Once you find an issue to work on, you are welcome to open a PR with a fix.
docs: following `markdownlint` rules for consistency closes #75 Here is a list of rules that have been applied: - [MD009](https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md) - Trailing spaces - [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) - Headings should be surrounded by blank lines - [MD025](https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md) - Multiple top-level headings in the same document - [MD026](https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md) - Trailing punctuation in heading - [MD029](https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md) - Ordered list item prefix - [MD031](https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md) - Fenced code blocks should be surrounded by blank lines - [MD032](https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md) - Lists should be surrounded by blank lines - [MD034](https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md) - Bare URL used - [MD041](https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md) - First line in a file should be a top-level heading - [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) - Files should end with a single newline character docs: removal of duplicated links and improvements Furthermore, duplicated links to the Official Cert-Manager Documentation have been removed. Additionally, some files have been enhanced with improved titles and added short descriptions.
2023-06-01 08:28:09 +02:00
## Your PR is merged
Add CONTRIBUTING.md
2022-06-08 15:59:26 +02:00
Once reviewed and accepted, your PR would be merged and available publicly.
doc: added contributing.md
2022-06-08 16:12:17 +02:00
Congratulations 🎉🎉 and thank you for playing your part ✨.