Skip to content

Commit 6b2da10

Browse files
authored
chore: add conventional pr title check action, contributing, and code-of-conduct (#15)
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
1 parent a44cbc4 commit 6b2da10

File tree

3 files changed

+160
-0
lines changed

3 files changed

+160
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: PR Conventional Commit Validation
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
pull-requests: write
9+
issues: write
10+
11+
defaults:
12+
run:
13+
shell: bash
14+
15+
jobs:
16+
validate-pr-title:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: PR Conventional Commit Validation
20+
uses: ytanikin/pr-conventional-commits@8267db1bacc237419f9ed0228bb9d94e94271a1d # v1.4.1
21+
with:
22+
task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'

CODE_OF_CONDUCT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and maintainers of this project pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, inclusive, and healthy environment.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our project include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior by participants include:
20+
21+
- The use of sexualized language or imagery, and unwelcome sexual attention or advances
22+
- Trolling, insulting/derogatory comments, and personal attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Our Responsibilities
28+
29+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all project spaces, both physical and online, when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
This Code of Conduct also applies outside project spaces when the individual is representing the project or its community in public spaces.
38+
39+
## Enforcement
40+
41+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [your.email@example.com]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
42+
43+
## Enforcement Guidelines
44+
45+
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem to be in violation of this Code of Conduct:
46+
47+
- **Contribution Removal**: Violations of the Code of Conduct may result in a temporary or permanent ban on the ability to contribute to the project.
48+
- **Warning**: The offending participant may be given a warning after the first instance of inappropriate behavior.
49+
- **Temporary Ban**: If the inappropriate behavior continues, the participant may be temporarily banned from participating in the community for a period of time.
50+
- **Permanent Ban**: In extreme cases, an individual may be permanently banned from contributing to the project.
51+
52+
## Attribution
53+
54+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to update-custom-properties
2+
3+
Thank you for your interest in contributing to the `update-custom-properties` project! Whether you're submitting a bug report, fixing a bug, or adding a feature, we appreciate your help in making this action better.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
If you've encountered a bug or have a suggestion for improvement, please check the [Issues](https://github.com/PandasWhoCode/update-custom-properties/issues) tab to see if it's already been reported. If not, feel free to open a new issue with as much detail as possible, including:
10+
11+
- A clear description of the problem or feature request.
12+
- Steps to reproduce the issue (if applicable).
13+
- The expected behavior and any error messages.
14+
- Your environment details (e.g., operating system, GitHub Actions version).
15+
16+
### Submitting a Pull Request
17+
18+
We welcome contributions through pull requests! To submit a pull request:
19+
20+
1. **Fork the repository**:
21+
Click the "Fork" button at the top of the repository page to create a copy of the project under your GitHub account.
22+
23+
2. **Clone your fork**:
24+
Clone your forked repository to your local machine:
25+
```bash
26+
git clone https://github.com/YOUR_USERNAME/update-custom-properties.git
27+
```
28+
29+
3. **Create a branch**:
30+
Create a new branch for your changes:
31+
```bash
32+
git checkout -b feature-branch
33+
```
34+
35+
4. **Make your changes**:
36+
Make your changes to the codebase. Ensure that you test your changes thoroughly and maintain existing functionality.
37+
38+
5. **Commit your changes**:
39+
Commit your changes with a clear and concise commit message. Follow the [Conventional Commit](https://www.conventionalcommits.org/) guidelines if possible.
40+
```bash
41+
git commit -m "feat: added new feature to install specific version"
42+
```
43+
44+
6. **Push your changes**:
45+
Push your changes to your forked repository:
46+
```bash
47+
git push origin feature-branch
48+
```
49+
50+
7. **Create a Pull Request**:
51+
Open a pull request (PR) from your feature branch to the `main` branch of the original repository.
52+
53+
8. **Describe your changes**:
54+
Provide a detailed description of the changes you made in the PR and link any relevant issues.
55+
56+
### Code Style
57+
58+
- Use [Prettier](https://prettier.io/) to format your code.
59+
- Ensure that your code follows the conventions and structure of the existing codebase.
60+
61+
### Testing
62+
63+
Ensure that your changes do not break existing functionality. If possible, include tests for any new features or bug fixes.
64+
65+
### Documentation
66+
67+
If you make changes that affect how the action works or how it is used, please update the documentation (including the `README.md` and this `CONTRIBUTING.md`) to reflect the changes.
68+
69+
## License
70+
71+
By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/PandasWhoCode/update-custom-properties?tab=Apache-2.0-1-ov-file#readme).
72+
73+
## Code of Conduct
74+
75+
By participating in this project, you agree to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md). We strive to maintain a welcoming and respectful community for everyone.
76+
77+
## Thank You!
78+
79+
Your contributions are what make this project great. Thank you for helping improve `update-custom-properties`!
80+
81+
---
82+
83+
**Author**: [Roger Barker](https://github.com/DJ-BBot)
84+
**Email**: [roger@pandaswhocode.com](mailto:roger@pandaswhocode.com)

0 commit comments

Comments
 (0)