Skip to content

Commit 69b584c

Browse files
committed
adjust readme
1 parent 5cd2ac5 commit 69b584c

File tree

2 files changed

+40
-47
lines changed

2 files changed

+40
-47
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to CodeBeaver GitHub Action
2+
3+
We love your input! We want to make contributing to the CodeBeaver GitHub Action as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
13+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
16+
17+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `main`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Any contributions you make will be under the MIT Software License
27+
28+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29+
30+
## Report bugs using Github's [issue tracker](https://github.com/codebeaver-ai/codebeaver-action/issues)
31+
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/codebeaver-ai/codebeaver-action/issues/new); it's that easy!
33+
34+
## License
35+
36+
By contributing, you agree that your contributions will be licensed under its MIT License.
37+
38+
## References
39+
40+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -68,50 +68,3 @@ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md)
6868
## License
6969

7070
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
71-
72-
---
73-
74-
# Contributing guidelines
75-
76-
# CONTRIBUTING.md
77-
78-
# Contributing to CodeBeaver GitHub Action
79-
80-
We love your input! We want to make contributing to the CodeBeaver GitHub Action as easy and transparent as possible, whether it's:
81-
82-
- Reporting a bug
83-
- Discussing the current state of the code
84-
- Submitting a fix
85-
- Proposing new features
86-
- Becoming a maintainer
87-
88-
## We Develop with Github
89-
90-
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
91-
92-
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
93-
94-
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
95-
96-
1. Fork the repo and create your branch from `main`.
97-
2. If you've added code that should be tested, add tests.
98-
3. If you've changed APIs, update the documentation.
99-
4. Ensure the test suite passes.
100-
5. Make sure your code lints.
101-
6. Issue that pull request!
102-
103-
## Any contributions you make will be under the MIT Software License
104-
105-
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
106-
107-
## Report bugs using Github's [issue tracker](https://github.com/codebeaver-ai/codebeaver-action/issues)
108-
109-
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/codebeaver-ai/codebeaver-action/issues/new); it's that easy!
110-
111-
## License
112-
113-
By contributing, you agree that your contributions will be licensed under its MIT License.
114-
115-
## References
116-
117-
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

0 commit comments

Comments
 (0)