github.com/projectcontour/contour@v1.28.2/site/content/docs/1.20/start-contributing.md (about)

     1  # Getting Started with Contributing
     2  
     3  Thanks for your interest in contributing to Contour. Community contributions are always needed, welcome, and appreciated. This guide shows how you can contribute to Contour in the following areas:  
     4  
     5  - Code
     6  - Website
     7  - Documentation  
     8  
     9  Please familiarize yourself with the [Code of Conduct][1] and project [Philosophy][15] before contributing.  
    10  
    11  # Getting Started with Code  
    12  
    13  Everything is managed on the [Project Contour GitHub][2] organization. Create an issue for a new idea or look for issues labeled **good first issue** to get started.  
    14  
    15  ## How we work  
    16  
    17  See [How We Work][3] for an overview:
    18  - Issue management
    19  - Code reviews
    20  - Coding practice
    21  - GitHub labels  
    22  
    23  ## Contribution workflow  
    24  
    25  Review the [Contribution workflow][4] to understand how to work with the code.  
    26  
    27  Below is a list of workflow areas:
    28  - Building from source
    29  - Contribution workflow
    30  - Contour testing
    31  - Developer Certificate of Origin (DCO) sign off  
    32  
    33  # Getting Started with the Website  
    34  
    35  Updates, corrections, or improvements are managed through [GitHub][16] issues.  
    36  
    37  When you are ready to take on an issue, see [Website Contribution Guidelines][5] to understand how the Contour website contributions are managed. There is information on:
    38  - Site structure
    39  - Link formatting
    40  - Testing
    41  - Setting up your environment  
    42  
    43  # Getting Started with Documentation  
    44  
    45  Documentation is critical to the success of any project. Open to all levels, Contour needs help to create and update its documentation. Join an [office hours][9] meeting and learn more about the Tech Docs Working Group.  
    46  
    47  Review the [Contour Technical Documentation Contributing Guide][6] for instructions to set up your environment.  
    48  
    49  Technical documentation will follow the [Website Contribution Guidelines][5].  
    50  
    51  ## New documentation suggestions  
    52  
    53  If you have a document suggestion, create an issue in [GitHub][16]. The team will triage and prioritize the issue. Connect on Slack or in a meeting to discuss your issue or request.  
    54  
    55  ## Helping with identified document issues  
    56  
    57  Take a look at the project issues list with the label **area/documentation**. If you are new to technical writing, add in the **good first issue** label: 
    58  [area/documentation and good first issue][7]
    59  
    60  Reach out on Slack or a Contour meeting for any assistance. Help is always appreciated.  
    61  
    62  # Filing and Working on Issues  
    63  
    64  Whether code, website, or documentation, Contour uses GitHub to create, track, and manage all issues.  
    65  
    66  If there is a fix or a suggestion for improvement, create an issue in [GitHub][16].  
    67  
    68  All issues are reviewed and evaluated by the Contour team.  
    69  
    70  # Meet the Community and the Team  
    71  
    72  To find out more about contributing to Contour, connect with us at a Contour Community Meeting, on Slack, or through the mailing list. We also have an Office Hours meeting to answer “How do I…” questions.  
    73  
    74  ## Contour Community meetings  
    75  
    76  Discuss issues, features, or suggestions with the Contour team and other community members.  
    77  
    78  See the [Community][8] page for:
    79  - Meeting schedule
    80  - Meeting notes with zoom link
    81  - Meeting recordings  
    82  
    83  ## Contour Office Hours meetings  
    84  
    85  Ask anything during office hours and find out more about Contour. 
    86  
    87  Ask questions:
    88  - “How do I do this in Contour?”
    89  - “Why does Contour do this thing this way?”
    90  - “Where can I find…?”  
    91  
    92  See the [Office Hours][9] page for:
    93  - Meeting schedule
    94  - Meeting link
    95  - Meeting recordings  
    96  
    97  ## Mailing list  
    98  
    99  To get email updates to Contour, join the [mailing list][10]. Topics include:
   100  - Release notifications
   101  - Issues
   102  - Feedback and suggestions
   103  - Meeting notifications  
   104  
   105  ## Find us  
   106  There are many ways to connect with the Contour team:
   107  
   108  - Slack:	Kubernetes [#contour][11]
   109  - Contour YouTube Channel:	[CNCF Contour][12]
   110  - Twitter:	[@projectcontour][13]
   111  - GitHub:	[projectcontour][14] 
   112  
   113  # Want More Contributing Information?  
   114  
   115  Slack or a meeting is a great way to introduce yourself. Let us know what you are interested in, your background, and what you want to accomplish.  
   116  
   117  # Next steps  
   118  
   119  Come out and join a [Community meeting][8] or an [Office Hours meeting][9]. Ask questions about how to get started or just sit back and get to know the team.
   120  
   121  
   122  
   123  [1]: {{< param github_url >}}/blob/main/CODE_OF_CONDUCT.md
   124  [2]: https://github.com/projectcontour
   125  [3]: {{< relref "resources/how-we-work.md" >}}
   126  [4]: {{< param github_url >}}/blob/main/CONTRIBUTING.md
   127  [5]: {{< param github_url >}}/blob/main/SITE_CONTRIBUTION.md
   128  [6]: {{< relref "resources/contributing-docs.md" >}}
   129  [7]: {{< param github_url >}}/issues/?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation+label%3A%22good+first+issue%22
   130  [8]: {{< relref "community.md" >}}
   131  [9]: https://github.com/projectcontour/community/wiki/Office-Hours
   132  [10]: https://lists.cncf.io/g/cncf-contour-users/
   133  [11]: {{< param slack_url >}}
   134  [12]: https://www.youtube.com/channel/UCCde7QSfcyYJ8AuXofD5bTA
   135  [13]: https://twitter.com/projectcontour
   136  [14]: https://github.com/projectcontour
   137  [15]: {{< relref "resources/philosophy.md" >}}
   138  [16]: {{< param github_url >}}/issues/
   139  [17]: {{< param github_url >}}/