Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 3.41 KB

Here is an updated version of your CONTRIBUTING.md file with some changes to improve clarity and organization:

Contributing

Thank you for your interest in contributing to Lesma! In this document, you'll find guidelines, tips, and tricks to help you contribute effectively.

Getting Started

Before making any code changes, we strongly recommend visiting the Getting Started section of the documentation to install the necessary prerequisites.

Feature Requests

If you have an idea for a new feature or an enhancement to Lesma, start a discussion and provide detailed information about the proposed changes and their benefits.

Bug Reports

Before reporting a bug, please search existing issues to ensure it hasn't already been reported. If you can't find a suitable issue, create a new one and provide the following details:

  • A short summary of what you were trying to achieve
  • The code causing the bug
  • The expected result
  • The actual results
  • Environment details, such as operating system and compiler version (lesma -v)

If possible, isolate the problem and provide just enough code to demonstrate it. Include any related information that might help to fix the issue.

Contributing Code

We use a standard GitHub pull request workflow. If you have already contributed to a project via GitHub pull request, you can skip this section and proceed to the specific details of what we ask for in a pull request. If this is your first time contributing to a project via GitHub, follow these steps:

  1. Fork the Lesma repo using the GitHub website. This will create a copy of the Lesma repo under your GitHub account.
  2. Clone your Lesma repo to your local machine.
  3. Create a branch for your changes.
  4. Make your changes on that branch.
  5. Push your changes to your repo.
  6. Use the GitHub website to open a pull request (PR).

Keep these points in mind:

  1. Your fork doesn't automatically stay up to date with changes in the main repo.
  2. Any changes you make on your PR branch will automatically appear in the PR, so always create different branches for multiple PRs.
  3. To avoid commit history issues, always create your PR branches from the main branch.

Refer to the official GitHub documentation for more information. Some useful resources include:

Pull Requests

We use Semantic Release in our CI, which relies on Conventional Commits for commit messages. Our CHANGELOG with all the changes in Lesma is generated based on Semantic Release and Git commit messages.

Please familiarize yourself with the commit message style to avoid having to rename commits during a PR:

When submitting a PR, remember to:

  • Create one PR per feature. Don't combine unrelated changes.
  • Ensure your PR is based on the latest main