Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

95 lines (65 loc) · 3.4 KB
Raw

Contributing Guidelines

Contribution is welcome, encouraged, and appreciated. There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into eve itself.

Here are some guidelines for contributing back to this project.

Table of Content:

Code of Conduct

First, please take a moment to review our Code of Conduct.

Reporting Issues

Bug Report

If you have a bug, please be so kind as to search for any open issue already covering your problem.

If you find one, comment on it, so we know more people are experiencing it.

If not, you can go ahead and create a bug report with as much detail as you can provide.

Feature Request

Please be so kind as to search for any open issue already covering your enhancement.

If you find one, comment on it, so we know more people are supporting it.

If not, you can go ahead and create a feature request. Or you can start a new discussion in the Ideas category of eve Discussions.

Submitting Pull Requests

Getting Started

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub. See also First Timers Only.

Search for any open or closed PR that relates to your submission.

If you don't find one:

  1. Fork https://github.com/cezelot/eve to your GitHub account.
  2. Clone the forked repository.
  3. Create a new git branch.
  4. Make your changes in the new branch.
  5. Commit your changes using a descriptive commit message that follows our commit message conventions.
  6. Push your branch to GitHub.
  7. Send a pull request to eve:main.

Coding Style Guidelines

...

Commit Message Guidelines

eve uses the Conventional Commits specification.

<type>[optional scope]: <description>
[BLANK LINE]
[optional body]
[BLANK LINE]
[optional footer(s)]

For consistency, please write in lowercase the first commit line, excluding proper names (GitHub, ...) and file names (README.md, ...).

Try to keep the first commit line short. It's harder to do using this commit style but try to be concise, and if you need more space, you can use the commit body. Try to make sure that the commit subject is clear and precise enough that we will know what changed by just looking at the commit logs.

The commit subject may contain formatted inline code by using backticks:

feat: add `--version` command-line option

That's it! Thank you for your contribution!