Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (52 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 3.01 KB

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Filing bugs, change requests and questions

You can file bugs, change requests, and questions about the project via GitHub Issues. Consult GitHub Help for more information on using GitHub Issues.

Community Guidelines

This project follows the following Code of Conduct.

Source Code Headers

Every file containing source code must include copyright and license information. This includes any JS/CSS files served to browsers. (This is to help well-intentioned people avoid accidental copying that doesn't comply with the license.)

Mozilla header:

SPDX-FileCopyrightText: 2019-2025 Alliander N.V.
SPDX-License-Identifier: MPL-2.0

Git branching

This project uses the Gitflow Workflow branching model.

  • The master branch always contains the latest release.
  • New feature branches are branched off from develop.
  • Finished features are merged back into develop.
  • At the end of a sprint, develop is merged into master, or optionally into a release branch before merging into master.

Gitflow

Code reviews

All patches and contributions, including those by project members, require review by a maintainer. We use GitHub pull requests for this. Consult GitHub Help for more info.

Pull Request Process

Contributions should be submitted as GitHub pull requests. See Creating a pull request if you're unfamiliar with the process.

Steps to follow

  1. Create a topic branch in your local repository named like: feature-[description]. See the Git branching guideline for naming conventions.

  2. Make changes, compile, and test thoroughly. Ensure all install/build dependencies are removed by the end of the build process. Follow existing code style and focus on the relevant topic. See the style guide for more details.

  3. Push commits to your fork.

  4. Create a GitHub pull request from your topic branch.

  5. A maintainer will review your pull request. They may offer feedback, request changes, or approve the contribution. See the code review guideline for expectations.

  6. Once a maintainer signs off, you may merge your changes. If you don't have permission, a maintainer can merge it for you.

Attribution

This CONTRIBUTING.md is adapted from Google’s contributing guide.