Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/comment_contributing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ jobs:
comment-on-pr:
uses: canonical/operator-workflows/.github/workflows/comment_contributing.yaml@main
secrets: inherit
steps:
- name: Add dynamic PR comment with status
run: |
pr_url="https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"
message="🚀 PR opened by @${{ github.actor }}. Current PR status: *${{ github.event.pull_request.state }}*."
curl -X POST -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -d "{\"body\":\"$message\"}" $pr_url
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 🤝 Contribution
## Contribution

For consistency with the other section headers :)


We welcome all suggestions and improvements! If you have ideas, bug fixes, or new features, feel free to contribute.

### How to contribute:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### How to contribute:
### How to contribute


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Create a Pull Request and describe the changes you made.
5. Create a pull request and describe the changes you made.


📋 Pull Request Guidelines:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
📋 Pull Request Guidelines:
### Pull request guidelines

* 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
Copy link
Contributor

Choose a reason for hiding this comment

The 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
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make a review, please

Copy link
Contributor

Choose a reason for hiding this comment

The 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!