Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

101 lines (67 loc) · 3.78 KB
Raw

Contributing to dotenvy

Thank you very much for considering to contribute to this project!

We welcome any form of contribution, including:

  • reporting or fixing bugs
  • requesting or adding features
  • doc changes (including spelling/grammar corrections)
  • adding examples
  • asking for help, sharing ideas

Note: Before making a large change, it is a good idea to open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged and help avoid multiple people writing the same solution.

This guide will help you get started. Do not let this guide intimidate you. It should be considered a map to help you navigate the process.

Conduct

The dotenvy project adheres to the Rust Code of Conduct.

Issues

Please feel free to open new issues, or comment on existing ones. If you would like to attempt to implement a change, you can ask for help or guidance on solving a problem, or just let us know you are working on it.

A maintainer will mark the issue as assigned to you to avoid other people unknowingly working on the same thing. If you would like to work on an assigned issue that has not been updated in a while, just ask to have it reassigned to you.

This project sometimes has longer form discussions. Feel free to comment on existing threads or open your own.

Pull Requests

Pull Requests are the way concrete changes are made to the code, documentation, and dependencies in the dotenvy repository.

Even tiny PRs, like a one character change to fix a typo in the docs, are greatly appreciated. Before making a large change, it is recommended to first open an issue describing the change as to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.

Tests

If you are modifying the code, make sure all tests pass. If you are adding new functionality, please add related tests.

Discuss and update

If you receive feedback on your PR, please don't be discouraged. It's just part of the process to ensure that changes to the project are correct and necessary.

Any community member can review a PR.

Commit Squashing

There is no need to squash your commits manually. PRs are usually squash merged anyway.

CI

Please ensure that your PR passes the CI checks:

If you are on a *nix system, you can use the scripts/ci-check.sh script to quickly check if you pass the CI checks.

Add an entry to the changelog

If your contribution changes the behavior of dotenvy, please update the CHANGELOG.md file and describe your changes. This makes the release process much easier and therefore helps to get your changes into a new dotenvy release faster.

The top of the CHANGELOG contains an Unreleased section with a few subsections (Added, Changed, etc) Please add your entry to the subsection that best describes your change. If a relevant subsection does not yet exist, please create it.

Entries follow this format:

### Changed

- Short description of what has been changed ([PR #123](pull.request.url)) by [username](github.profile.url)
- [**BREAKING**] Please prefix any breaking changes

Here, #123 is the number of your pull request.

NOTE: It is a good idea to push the changelog update to your branch after opening the PR. That way you can copy the number and link.