feat: add a "Contribution" section to the README.md #483

callogan · 2025-03-13T17:52:10Z

Closes #464

Overview

Enhancing the README.md by adding a dedicated section that encourages and guides external contributors on how to contribute to the project.

Closes canonical#464

callogan

Submit

callogan · 2025-03-13T17:54:17Z

README.md

+
+## 🤝 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! 🚀


Make a review, please

Hi, I have left a review :) Let me know if you have any questions!

Closes canonical#465

erinecon

Hello, thank you so much for your interest in adding to our documentation!

I see that you previously raised an issue, and I think it's a great point to emphasize that we are open to external contributions! Our documentation about contributing to the project has historically been located in CONTRIBUTING.md -- ultimately I would recommend that you move the bulk of your suggested text into CONTRIBUTING.md so all the contributing documentation lives together.

I left some comments, mostly nitpicks from my end :) please let me know if you have any questions or want to discuss further about my suggestion! Thanks again!

erinecon · 2025-03-13T18:35:59Z

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


Suggested change

## 🤝 Contribution

## Contribution

For consistency with the other section headers :)

erinecon · 2025-03-13T18:36:21Z

README.md

+  ```
+5. Create a Pull Request and describe the changes you made.
+
+📋 Pull Request Guidelines:


Suggested change

📋 Pull Request Guidelines:

### Pull request guidelines

erinecon · 2025-03-13T18:36:37Z

README.md

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


Suggested change

### How to contribute:

### How to contribute

erinecon · 2025-03-13T18:45:18Z

README.md

+  ```bash
+  git push origin feature/your-feature
+  ```
+5. Create a Pull Request and describe the changes you made.


Suggested change

5. Create a Pull Request and describe the changes you made.

5. Create a pull request and describe the changes you made.

erinecon · 2025-03-13T18:48:22Z

README.md

+### 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.


I would move this text into CONTRIBUTING.md -- I think it would be a nice enhancement to what's already there!

erinecon · 2025-03-13T18:49:30Z

README.md

+
+## 🤝 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! 🚀


Hi, I have left a review :) Let me know if you have any questions!

callogan · 2025-03-18T09:52:10Z

Hello, Erin.
Thank you for paying attention to my contribution effort!
Your suggestion sounds reasonable, and I think it will be great idea to keep all contribution instructions in one place.

So, now I would like to ask you, how should we proceed:

to close this Pull request and related issue,
or
to keep this PR opened untill all necessary changes will be done?

erinecon · 2025-03-18T13:01:23Z

Hello, Erin. Thank you for paying attention to my contribution effort! Your suggestion sounds reasonable, and I think it will be great idea to keep all contribution instructions in one place.

So, now I would like to ask you, how should we proceed:

to close this Pull request and related issue,
or

to keep this PR opened untill all necessary changes will be done?

Hi Ruslan,

I just noticed that your commit wasn't signed, which is a requirement for contributing to this repository. I suggest that you close this PR and open a new one with your suggested changes in CONTRIBUTING.md -- I think it would be great for you to make the changes yourself 😄 . Please let me know if you have any questions or if I can help in any way! Thanks again for your interest in contributing to our documentation!

yanksyoon · 2025-03-19T03:06:04Z

@callogan Hello! Thanks for creating this PR! Unfortunately, we require all contributions to have signed commits (https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits), would you like to re-create the PR? (our repository rules disable any force pushes so you might need to amend commits and sign them or - recreate the PR with signed commits).
@jdkandersson Tagging you here for external contribution reference which might benefit from allowing force pushes.

feat: add a "Contribution" section to the README.md

50a63f7

Closes canonical#464

callogan requested review from cbartz, yhaliaw and javierdelapuente as code owners March 13, 2025 17:52

callogan commented Mar 13, 2025

View reviewed changes

feat: add dynamic PR comments with author and build status

cfeffa3

Closes canonical#465

erinecon reviewed Mar 13, 2025

View reviewed changes

erinecon added the documentation Improvements or additions to documentation label Mar 13, 2025

Merge branch 'main' into callogan

8211f84

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add a "Contribution" section to the README.md #483

feat: add a "Contribution" section to the README.md #483

callogan commented Mar 13, 2025

callogan left a comment

callogan Mar 13, 2025

erinecon Mar 13, 2025

erinecon left a comment

erinecon Mar 13, 2025

erinecon Mar 13, 2025

erinecon Mar 13, 2025

erinecon Mar 13, 2025

erinecon Mar 13, 2025

erinecon Mar 13, 2025

callogan commented Mar 18, 2025

erinecon commented Mar 18, 2025

yanksyoon commented Mar 19, 2025


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

		### How to contribute:

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

feat: add a "Contribution" section to the README.md #483

Are you sure you want to change the base?

feat: add a "Contribution" section to the README.md #483

Conversation

callogan commented Mar 13, 2025

Overview

callogan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erinecon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

callogan commented Mar 18, 2025

erinecon commented Mar 18, 2025

yanksyoon commented Mar 19, 2025