Skip to content

Latest commit

 

History

History
83 lines (48 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

83 lines (48 loc) · 2.07 KB

Welcome to Ormus!

First of all, thank you for taking the time to contribute! 🎉👍

Issue Creation Guidelines

Feature Request

Description

Provide a clear and detailed description of the new feature you are proposing.

Use Case

Explain the use case or scenario where this feature would be beneficial.

Expected Behavior

Describe what you expect the new feature to do.

Additional Information

Include any additional information that might be relevant to the feature request, such as examples, related issues, or similar features in other projects.

Bug Report

Description

When creating a bug report, please clearly and concisely describe the issue you encountered.

Steps to Reproduce

Include detailed steps to reproduce the bug, if possible. This helps in identifying the root cause of the issue.

Expected Behavior

Describe what you expected to happen when encountering the bug.

Actual Behavior

Explain what happened when encountering the bug.

Additional Information

Include any additional information that might be helpful in debugging the issue, such as screenshots, error messages, or relevant code snippets.

Contribution Guidelines

Commit Message Guidelines

Please follow the Conventional Commits message format for your commits. This helps in generating meaningful changelogs and maintaining a structured commit history.

Before Creating a Pull Request

Before creating a pull request, ensure the following steps have been completed:

  1. Linting: Ensure your code follows the linting rules.
  2. Formatting: Format your code according to the project's standards.
  3. Testing: Run tests to ensure your changes do not break existing functionality.

Commands to Run

Before creating a pull request, execute the following commands:

make lint
make format
make test

These commands will check for lint errors, format your code, and run tests to ensure the changes meet the project's standards and do not introduce regressions.

have a good day :)