Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 1.62 KB
Raw

💡 Contributing

Thanks a lot for your interest in contributing to leon-cli! 🎉

Code of Conduct

Leon has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Open Development

All work on Leon happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Types of contributions

  • Reporting a bug.
  • Suggest a new feature idea.
  • Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
  • Improve structure/format/performance/refactor/tests of the code.

Development Setup

# Download the source code
git clone [email protected]:leon-ai/leon-cli.git

# Install npm dependencies
npm install

# Add your awesome changes...

# Build
npm run build

# Install the local folder as a global npm package
npm install --global

# Run
leon

Pull Requests

  • Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time.

  • Ensure your code respect linting.

  • Make sure your code passes the tests.

If you're adding new features to leon-cli, please include tests.

Commits

The commit message guidelines adheres to Conventional Commits and Semantic Versioning for releases.