Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #1

Merged
merged 3 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .ansible-lint
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
skip_list:
- yaml[truthy]
- yaml[line-length]
- yaml[truthy]
- yaml[line-length]
exclude_paths:
- public/decapcms/config.yml
2 changes: 1 addition & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Expose Astro dependencies for `pnpm` users
shamefully-hoist=true
shamefully-hoist=true
15 changes: 4 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ repos:
- id: check-json
- id: check-merge-conflict
- id: check-shebang-scripts-are-executable
exclude: "^(codeTemplates/|tempalte/|{% if code_templates %}codeTemplates{% endif %}/)"
exclude: '^(codeTemplates/|tempalte/|{% if code_templates %}codeTemplates{% endif %}/)'
# - id: check-symlinks # I needed to disable since I use symbolic links to files outside my repo which will cause the CI check to fail.
- id: check-toml
- id: check-xml
Expand All @@ -29,14 +29,7 @@ repos:
rev: 1.0.5
hooks:
- id: shell-lint
args:
[
--format=json,
--color=always,
--exclude=SC3037,
--exclude=SC2148,
--severity=error,
]
args: [--format=json, --color=always, --exclude=SC3037, --exclude=SC2148, --severity=error]
- repo: https://github.com/antonbabenko/pre-commit-terraform
rev: v1.96.1
hooks:
Expand Down Expand Up @@ -64,8 +57,8 @@ ci:

for more information, see https://pre-commit.ci
autofix_prs: true
autoupdate_branch: ""
autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
autoupdate_branch: ''
autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
autoupdate_schedule: weekly
skip: []
submodules: false
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
dist
node_modules
.github
.changeset
.changeset
2 changes: 1 addition & 1 deletion .stackblitzrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
"env": {
"ENABLE_CJS_IMPORTS": true
}
}
}
20 changes: 10 additions & 10 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
- The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# Contributing to Evan Harmon Website

First of all, thank you for taking the time to contribute! 🎉

The following is a set of guidelines to ensure your contribution is as smooth as possible. We welcome all types of contributions, including issues, documentation updates, bug fixes, feature requests, and more!

## Code of Conduct

This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Evan Harmon at evan@evanharmon.com.

## How Can I Contribute?

### 1. Reporting Issues

If you find a bug or have a feature request, please create an issue using the appropriate template:

- **Bug Reports:** [bug report link]
- **Feature Requests:** [feature request link]

When submitting an issue, please include the following information:

- Clear title describing the issue.
- Steps to reproduce (for bugs).
- Any relevant screenshots or code snippets.
- Version of the project or environment.

### 2. Submitting Pull Requests

Before starting work on a major change, open an issue first to discuss your proposed changes. This will avoid any duplication of effort and ensure your contribution aligns with the project goals.

To submit a pull request:

1. Fork the repository and clone your fork.
2. Create a new branch for your contribution: `git checkout -b my-feature-branch`
3. Make your changes.
Expand All @@ -32,25 +39,30 @@ To submit a pull request:
7. Open a pull request in the main repository, linking to the issue if one exists.

### 3. Guidelines for Code Contributions

- Follow the existing code style. If there is an `.editorconfig` or linter configuration, use it to format your code.
- Write clear, descriptive commit messages.
- Write unit tests for any new functionality or bug fixes, if applicable.
- Ensure that tests pass locally before submitting your pull request.
- Document new public methods or features in the relevant documentation files.

### 4. Improving Documentation

We also appreciate improvements to our documentation!

You can:

- Fix typos, clarify instructions, or correct grammar.
- Add new sections or examples for difficult concepts.

Feel free to submit a pull request with your improvements.

## Commit Message Guidelines

We follow the [Conventional Commits](https://www.conventionalcommits.org) standard for writing commit messages. This helps us manage the code history, generate changelogs, and automate CI/CD tooling. Example:

Example commit message:

```
feat(api): add support for custom endpoints

Expand All @@ -59,6 +71,7 @@ Resolves issue #42.
```

Commit message structure:

```
<type>[optional scope]: <description>

Expand All @@ -68,6 +81,7 @@ Commit message structure:
```

Types:

- feat: A new feature for the user.
- fix: A bug fix for the user.
- chore: Routine tasks (e.g., build tasks, dependencies).
Expand All @@ -81,6 +95,7 @@ Types:
- revert: Reverts a previous commit.

## Contact

If you have any questions about contributing, feel free to open an issue or contact Evan Harmon at evan@evanharmon.com.

Thank you for contributing!
Loading
Loading