Skip to content

Commit ccd0dc3

Browse files
committed
docs: centralize community files under .github and update README links
1 parent 4c9e43b commit ccd0dc3

File tree

5 files changed

+41
-12
lines changed

5 files changed

+41
-12
lines changed
File renamed without changes.

.github/CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
Here's how to get started:
4+
5+
1. Fork the repo, then `git clone` your fork.
6+
2. Create a feature branch: `git checkout -b feat/my-feature`.
7+
3. Run tests: `bundle exec rspec`.
8+
4. Make your changes, commit, and push up your branch.
9+
5. Open a Pull Request describing your change.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- PR Template -->
2+
3+
## Summary
4+
A brief, one-sentence description of what this PR does.
5+
Link any related issues, e.g. `Closes #123`.
6+
7+
## Motivation
8+
Why is this change needed? What problem does it solve?
9+
10+
## Changes
11+
- High-level bullet points of the main changes.
12+
- New or modified classes/methods.
13+
- Any backward-incompatible changes.
14+
15+
## Types of Changes
16+
- [ ] Bug fix
17+
- [ ] New feature
18+
- [ ] Breaking change
19+
- [ ] Documentation update
20+
21+
## Checklist
22+
- [ ] I’ve added or updated tests and they pass (`bundle exec rspec`)
23+
- [ ] I’ve updated the README or relevant docs
24+
- [ ] I’ve bumped the version if this is a user-visible change
25+
- [ ] CI is green

CONTRIBUTING.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,13 @@ After cloning the repo, install dependencies with `bundle install`, then run tes
123123

124124
## Contributing
125125

126-
Bug reports and pull requests are welcome on GitHub at https://github.com/dbongo/callable-mixin.
126+
Please follow these resources before submitting code or issues:
127+
128+
- [Code of Conduct](https://github.com/dbongo/callable-mixin/blob/main/.github/CODE_OF_CONDUCT.md)
129+
- [Contributing Guide](https://github.com/dbongo/callable-mixin/blob/main/.github/CONTRIBUTING.md)
130+
- [Pull Request Template](https://github.com/dbongo/callable-mixin/blob/main/.github/PULL_REQUEST_TEMPLATE.md)
131+
132+
Bug reports and pull requests are welcome on GitHub: https://github.com/dbongo/callable-mixin
127133

128134
## License
129135

0 commit comments

Comments
 (0)