Skip to content

Commit 0d3a1a6

Browse files
authored
Merge pull request cds-hooks#481 from buildpacks/feature/start-contrib
Add guidance on how to start contributing
2 parents a747f43 + 6c77c3c commit 0d3a1a6

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

content/community.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,34 @@ Partake in one or many of our following public events:
1313

1414
## Contributing
1515

16+
#### How can I start contributing?
17+
18+
If you are new to the project, the first thing you should do is gain some understanding of the project. This normaly entails doing the following:
19+
20+
1. Watch a few [talks (videos)][talks].
21+
2. Next, run through some [tutorials][tutorials].
22+
23+
If you run into issues or unexpected behaviour, that's probably the best place to start adding your first contribution.
24+
25+
If you didn't find anything you'd like to improve while going through the tutorials you can browse the repositories below (some of those repositories may even have ["good first issues"][good-first-issues]):
26+
27+
| Component | Tech Stack | Description
28+
|--- |--- |---
29+
| [`pack`][pack] | Go, Docker | CLI providing build and utility functions to end-users.
30+
| [`lifecycle`][lifecycle] | Go, Docker | Executables that implement the main [specifications][spec] and are used by [platforms][platforms] such as `pack`.
31+
| [`docs`][docs] | Hugo, HTML, JavaScript | Main website and documentation.
32+
33+
> Dependending our your depth of understading or desires some components may be more ideal than others.
34+
35+
[talks]: /docs/#talks
36+
[tutorials]: /docs/#tutorials
37+
[spec]: /docs/reference/spec/
38+
[platforms]: /docs/concepts/components/platform/
39+
[pack]: https://github.com/buildpacks/pack
40+
[lifecycle]: https://github.com/buildpacks/lifecycle
41+
[docs]: https://github.com/buildpacks/docs
42+
[good-first-issues]: https://github.com/search?q=org%3Abuildpacks+label%3A%22good+first+issue%22+state%3Aopen&type=Issues
43+
1644
#### What type of contributions can I make?
1745

1846
Buildpacks welcomes all types of contributions, not just those related to code. We value any help that you can provide, and are more than happy to guide you through the process.

0 commit comments

Comments
 (0)