Skip to content

Commit 3c9e930

Browse files
committed
docs: add contributing guidelines
1 parent b693abd commit 3c9e930

File tree

4 files changed

+85
-1
lines changed

4 files changed

+85
-1
lines changed

CODE_OF_CONDUCT.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
15+
- Focusing on what is best not just for us as individuals, but for the overall community
16+
17+
Examples of unacceptable behavior include:
18+
19+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
20+
- Trolling, insulting or derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or email address, without their explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Enforcement Responsibilities
26+
27+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
28+
29+
## Scope
30+
31+
This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces.
32+
33+
## Enforcement
34+
35+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <[email protected]>. All complaints will be reviewed and investigated promptly and fairly.
36+
37+
## Attribution
38+
39+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to smart-todo-action
2+
3+
Thank you for considering contributing to **smart-todo-action**! We welcome pull requests and issues.
4+
5+
## Development Setup
6+
7+
1. **Install dependencies**
8+
```bash
9+
yarn install
10+
```
11+
2. **Run tests**
12+
```bash
13+
yarn test
14+
```
15+
3. **Run the linter**
16+
```bash
17+
yarn lint
18+
```
19+
20+
## Pull Requests
21+
22+
- Fork the repository and create a new branch for your change.
23+
- Write tests for new functionality whenever possible.
24+
- Ensure `yarn test` passes before submitting.
25+
- Provide a clear description of your change in the PR body.
26+
27+
## Code Style
28+
29+
All functions should include docstrings in the [Google format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). Use inline comments to explain non-obvious logic.
30+
31+
## Reporting Issues
32+
33+
If you encounter a bug or have a feature request, please open an issue. Feel free to reach out via email if you need further assistance:
34+
35+
- Personal: <[email protected]>
36+
- Professional: <[email protected]>
37+
38+
## Code of Conduct
39+
40+
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,8 @@ This project is maintained by [Diogo Ribeiro](https://github.com/DiogoRibeiro7).
190190
- **Personal email:** <[email protected]>
191191
- **Professional email:** <[email protected]>
192192

193+
194+
## 🤝 Contributing
195+
196+
We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and make sure to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
197+

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into
6868

6969
> Foster an active ecosystem and support network.
7070
71-
- [ ] Contributor guidelines and code of conduct
71+
- [x] Contributor guidelines and code of conduct
7272
- [ ] Example workflows and tutorials
7373
- [ ] Discussion board or Discord for support
7474
- [ ] Regular release announcements

0 commit comments

Comments
 (0)