-
Notifications
You must be signed in to change notification settings - Fork 24
feat: add a "Contribution" section to the README.md #483
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -151,3 +151,34 @@ This repository contains the charm in the root directory and the Python package | |||||
* [Issues](https://github.com/canonical/github-runner-operator/issues) | ||||||
* [Contributing](https://charmhub.io/github-runner/docs/how-to-contribute) | ||||||
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) | ||||||
|
||||||
## 🤝 Contribution | ||||||
|
||||||
We welcome all suggestions and improvements! If you have ideas, bug fixes, or new features, feel free to contribute. | ||||||
|
||||||
### How to contribute: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
1. **Fork** the repository. | ||||||
2. **Create a new branch** for your feature or fix: | ||||||
```bash | ||||||
git checkout -b feature/your-feature | ||||||
``` | ||||||
3. Make changes and commit them: | ||||||
```bash | ||||||
git commit -m "Added a new feature: your-feature" | ||||||
``` | ||||||
4. Push the changes to your fork: | ||||||
```bash | ||||||
git push origin feature/your-feature | ||||||
``` | ||||||
5. Create a Pull Request and describe the changes you made. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
📋 Pull Request Guidelines: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
* Write clean and readable code. | ||||||
* Follow the existing code style of the project. | ||||||
* Add comments and documentation if necessary. | ||||||
* Ensure that your changes do not break existing functionality. | ||||||
Comment on lines
+159
to
+180
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would move this text into CONTRIBUTING.md -- I think it would be a nice enhancement to what's already there! |
||||||
|
||||||
Other important statements are described here: [Contributing](CONTRIBUTING.md) | ||||||
|
||||||
We appreciate your contribution! 🚀 | ||||||
Comment on lines
+154
to
+184
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Make a review, please There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi, I have left a review :) Let me know if you have any questions! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the other section headers :)