diff --git a/.github/workflows/comment_contributing.yaml b/.github/workflows/comment_contributing.yaml index c51f87314..5a3aeac7e 100644 --- a/.github/workflows/comment_contributing.yaml +++ b/.github/workflows/comment_contributing.yaml @@ -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 diff --git a/README.md b/README.md index f3976ef8f..05d74629b 100644 --- a/README.md +++ b/README.md @@ -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: + +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. + +📋 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. + +Other important statements are described here: [Contributing](CONTRIBUTING.md) + +We appreciate your contribution! 🚀