Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.95 KB
Raw

Contributing to mod_wasm

The mod_wasm project team welcomes contributions from the community. First, we want to thank you for taking the time to contribute!

Please familiarize yourself with the Code of Conduct before contributing.

Before you start working with mod_wasm, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

Ways to contribute

We welcome many different types of contributions and not all of them need a Pull request. Contributions may include:

  • New features and proposals
  • Documentation
  • Bug fixes
  • Issue Triage
  • Answering questions and giving feedback
  • Helping to onboard new contributors
  • Other related activities

Getting started

Check our [README.md] file to understand the structure of this project, the different parts and how to setup your development environment.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create an issue to discuss the feature or bug you want to work on
  • Make a fork of the repository within your GitHub account
  • Create a topic branch in your fork from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
  • Push your changes to the topic branch in your fork
  • Create a pull request containing that commit

We follow the GitHub workflow and you can find more details on the GitHub flow documentation.

Example:

# After forking the project:
git clone MY_FORK_URL
cd mod_wasm
git switch -c my-new-feature
git commit -s -S -a
git push origin my-new-feature

Pull Request Checklist

Before submitting your pull request, we advise you to use the following:

  1. Check if your code changes will pass both code linting checks and unit tests.
  2. Ensure your commit messages are descriptive. We follow the conventions on How to Write a Git Commit Message. Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.
  3. Check the commits and commits messages and ensure they are free from typos.

Reporting Bugs and Creating Issues

For specifics on what to include in your report, please follow the guidelines in the issue and pull request templates when available.

Ask for Help

The best way to reach us with a question when contributing is to ask on: