Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 3.85 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 3.85 KB
Raw

Contributing

Opening an Issue

  • If you experience or notice an error, bug, documentation issue, feel free to;
    1. Open a GitHub Issue against the project.
    2. Provide details and logs in the description on how to reproduce the issue.
    3. Provide details of the operating system type and version, custom configurations, versions of applications that are displaying the issue, if applicable.

Opening a Pull Request

Environment Setup

  1. To quickly get started with MicroK8s, use a supported Ubuntu distribution and follow the Getting Started MicroK8s guide.

  2. To create a multi-node MicroK8s cluster, review the Create a MicroK8s cluster guide. Ensure that you install the MicroK8s package on the node(s) that will be used to join your cluster.

    💡When adding nodes to a cluster, end users may experience a similar error message Connection failed. The hostname (node-fcac1e38-6872-4839-b2a0-e3c34db85428) of the joining node does not resolve to the IP "188.166.144.180". Refusing join (400). - To resolve this issue, a recommendation would be to review the issue #3225 and apply the workaround solution in the comment.

  3. Once your cluster is up and running, follow the detailed instructions on how to develop MicroK8s add-ons by reviewing the HACKING.md document located in the MicroK8s Community add-on repository.

    Ensure that the unit tests are applied as you will not be able to successflly enable or disable the add-on without them.

  4. Lastly, before running Ondat, ensure that the enable and disable scripts are executable files otherwise you will experience permission related issues.

# navigate into the Ondat directory.
cd addons/ondat/

# make "enable" and "disable" into executable files.
chmod +x enable disable

# enable the Ondat add-on.
microk8s enable ondat

Submit Your Changes

  • If you would like to contribute to the project, feel free to create a Pull Request;

    1. Fork the upstream repository.
    2. Clone the recently forked repository to your workstation.
    3. Navigate into the repository and create a branch and checkout into the new branch.
    4. Make changes that you would like to contribute, then add and commit changes to the repository.
    5. Push the changes you made in the local branch to your remote fork.
    6. Create a Pull Request against the upstream repository.

  • When working on the bash enable and disable scripts, a recommendation would be to leverage ShellCheck, which is a static analysis tool for checking shell scripts for bugs, warnings and providing suggestions to address issues found.

  • For the Python unit tests, a recommendation would be to use Black, which is an uncompromising Python code formatter that is useful for consistent code styling.