Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 4.39 KB

CONTRIBUTING.md

File metadata and controls

96 lines (68 loc) · 4.39 KB

Contributing

Getting Started

Some Ways to Contribute

  • Report potential bugs.
  • Suggest app enhancements.
  • Increase our test coverage.
  • Fix a bug.
  • Implement a requested enhancement.
  • Improve our documentation.
  • Respond to questions about usage on the issue tracker or Discord Server.

Reporting an Issue

Note: Issues on GitHub for CookCLI are intended to be related to bugs or feature requests. Questions should be directed to Discord Server or Spec Discussions.

  • Check existing issues (both open and closed) to make sure it has not been reported previously.

  • Provide a reproducible test case. If a contributor can't reproduce an issue, then it dramatically lowers the chances it'll get fixed.

  • Aim to respond promptly to any questions made by the CookCLI team on your issue. Stale issues will be closed.

Issue Lifecycle

  1. The issue is reported.

  2. The issue is verified and categorized by a CookCLI maintainer. Categorization is done via tags. For example, bugs are tagged as "bug".

  3. Unless it is critical, the issue is left for a period of time (sometimes many weeks), giving outside contributors a chance to address the issue.

  4. The issue is addressed in a pull request or commit. The issue will be referenced in the commit message so that the code that fixes it is clearly linked. Any change a CookCLI user might need to know about will include a changelog entry in the PR.

  5. The issue is closed.

Making Changes to CookCLI

Prerequisites

If you wish to work on CookCLI itself, you'll first need to:

  • install Rust for macOS, Linux or Windows.
  • (optional, only if you plan to change web-server) install NodeJS.
  • fork the CookCLI repo

Building CookCLI

To build CookCLI, run make dev or cargo build. In a few moments, you'll have a working cook executable in target/debug.

Note: make dev will build for your local machine's os/architecture.

Building server frontend

To start the frontend server in development mode use make dev_server. This will start API and Svelte development server in the background. Navigate to http://127.0.0.1:5000 to open the web-app.

Testing

No tests at the moment 🤞.

Submitting a Pull Request

Before writing any code, we recommend:

  • Create a Github issue if none already exists for the code change you'd like to make.
  • Write a comment on the Github issue indicating you're interested in contributing so maintainers can provide their perspective if needed.
  • Use Semantic Commit Messages, so release automation can kick-in.

Keep your pull requests (PRs) small and open them early so you can get feedback on approach from maintainers before investing your time in larger changes.

When you're ready to submit a pull request:

  1. Include evidence that your changes work as intended (e.g., add/modify unit tests; describe manual tests you ran, in what environment, and the results including screenshots or terminal output).
  2. Open the PR from your fork against base repository cooklang/CookCLI and branch main.
  3. Include any specific questions that you have for the reviewer in the PR description or as a PR comment in Github.
    • If there's anything you find the need to explain or clarify in the PR, consider whether that explanation should be added in the source code as comments.
    • You can submit a draft PR if your changes aren't finalized but would benefit from in-process feedback.
  4. After you submit, the CookCLI maintainers team needs time to carefully review your contribution and ensure it is production-ready, considering factors such as: correctness, backwards-compatibility, potential regressions, etc.
  5. After you address CookCLI maintainer feedback and the PR is approved, a CookCLI maintainer will merge it. Your contribution will be available from the next minor release.