Skip to content

Commit ccfc140

Browse files
committed
updates to contribution guidelines
1 parent 96d37e2 commit ccfc140

1 file changed

Lines changed: 52 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Contributions to Containerization are welcomed and encouraged.
44

5+
## Index
6+
7+
- [How you can help](#how-you-can-help)
8+
- [New to apple/containerization?](#new-to-applecontainerization)
9+
- [Submitting issues and pull requests](#submitting-issues-and-pull-requests)
10+
- [New to open source?](#new-to-open-source)
11+
- [AI contribution guidelines](#ai-contribution-guidelines)
12+
- [Code of conduct](#code-of-conduct)
13+
514
## How you can help
615

716
We would love your contributions in the form of:
@@ -14,15 +23,19 @@ We would love your contributions in the form of:
1423

1524
Anything else that could enhance the project!
1625

17-
## Submitting Issues and Pull Requests
26+
## New to apple/containerization?
27+
28+
To see the current list of maintainers, please refer to the [MAINTAINERS.txt](MAINTAINERS.txt) file in the repository.
29+
30+
## Submitting issues and pull requests
1831

1932
### Issues
2033

2134
To file a bug or feature request, use [GitHub issues](https://github.com/apple/containerization/issues/new).
2235

2336
🚧 For unexpected behavior or usability limitations, detailed instructions on how to reproduce the issue are appreciated. This will greatly help the priority setting and speed at which maintainers can get to your issue.
2437

25-
### Pull Requests
38+
### Pull requests
2639

2740
We require all commits be signed with any of GitHub's supported methods, such as GPG or SSH. Information on how to set this up can be found on [GitHub's docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#about-commit-signature-verification).
2841

@@ -55,23 +68,56 @@ We do not currently accept contributions to add editor specific additions to the
5568
git config --global core.excludesfile ~/.gitignore
5669
```
5770

58-
#### Formatting Contributions
71+
#### Formatting contributions
5972

6073
Make sure your contributions are consistent with the rest of the project's formatting. You can do this using our Makefile:
6174

6275
```bash
6376
make fmt
6477
```
6578

66-
#### Applying License Header to New Files
79+
#### Applying license header to new files
6780

6881
If you submit a contribution that adds a new file, please add the license header. You can do this using our Makefile:
6982

7083
```bash
7184
make update-licenses
7285
```
7386

74-
### AI Contribution Guidelines
87+
## New to open source?
88+
89+
### How do I pick something to work on?
90+
91+
In case you don't have anything specific to work on, you could
92+
start off by picking a [good first issue](https://github.com/apple/containerization/contribute). Before you start
93+
working on an issue:
94+
* Check the comments, assignees, and any references to pull requests — make sure
95+
nobody else is actively working on it, or awaiting help or review.
96+
97+
* If someone is assigned to the issue or volunteered to work on it, and there
98+
are no signs of progress or activity over at least the past month, don't
99+
hesitate to check in with them — it might be that the person moved on.
100+
101+
* Leave a comment that you have started working on it.
102+
103+
### Getting help
104+
105+
Once you start working on the issue, you will inevitably end up having a lot of questions. Don't be afraid to ask for help! The codebase is large and wrapping your head around it will take time. When asking for help, prefer giving as much information as possible, while highlighting the parts that you think are important. Refer to the [New to apple/containerization?](new-to-apple/containerization) section for the appropriate maintainers to ping.
106+
107+
### I didn't get a response from someone. What should I do?
108+
109+
It's possible that you ask someone a question in a issue/pull request and
110+
you don't get a response as quickly as you'd like. If you don't get a response
111+
within a week, it's okay to politely ping them using an `@` mention with a
112+
reminder. If you don't get a response for 2-3 weeks in a row, please ping
113+
someone else.
114+
115+
### I can't finish the contribution I started. :frowning_face:
116+
117+
Sometimes an issue ends up bigger, harder, or more time-consuming than expected — **and that’s completely fine.**
118+
Be sure to comment on the issue saying you’re stepping away, so that someone else is able to pick it up.
119+
120+
## AI contribution guidelines
75121

76122
We welcome thoughtful use of AI tools in your contributions to this repository. We ask that you adhere to these rules in order to preserve the project's integrity, clarity, and quality, and to respect maintainer bandwidth:
77123

@@ -81,6 +127,6 @@ We welcome thoughtful use of AI tools in your contributions to this repository.
81127

82128
AI tools should be used to **enhance, not replace** the human elements that make OSS special: learning, collaboration, and community growth.
83129

84-
## Code of Conduct
130+
## Code of conduct
85131

86132
To clarify of what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](https://github.com/apple/.github/blob/main/CODE_OF_CONDUCT.md "Code of Conduct").

0 commit comments

Comments
 (0)