Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 2.2 KB

Contributing Guidelines

Welcome to Kubernetes. We are excited about the prospect of you joining our community! The Kubernetes community abides by the CNCF code of conduct. Here is an excerpt:

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

Getting Started

We have full documentation on how to get started contributing here:

Installing the Admin Network Policy CRD

  1. Clone the repo: git clone https://github.com/kubernetes-sigs/network-policy-api.git
  2. Run cd network-policy-api && make install

Developing the Website

The site documentation is written in Markdown and compiled with mkdocs.

Setting up local development

  1. Install mkdocs and required plugins:

    pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin
    
  2. To build the docs, run make docs.

  3. To deploy the docs locally, run make local-docs

Mentorship

  • Mentoring Initiatives - We have a diverse set of mentorship programs available that are always looking for volunteers!

Contact Information