Skip to content

Latest commit

 

History

History
276 lines (179 loc) · 13.8 KB

CONTRIBUTING.md

File metadata and controls

276 lines (179 loc) · 13.8 KB
Raw

Contributing to Inner Ink

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Inner Ink Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to naffydharni006@gmail.com.

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Can you reliably reproduce the issue?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Read the Security Policy for more info.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Tip: Use the Bug Report issue template to make the report easily.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as status: needs more info. Bugs with the status: needs more info tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked status: confirmed, as well as possibly other tags (such as priority: *), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Inner Ink, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most Inner Ink users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Improving The Documentation

Clear and comprehensive documentation is essential for the success and usability of Inner Ink. Contributions to improving our documentation are highly appreciated. Here's how you can contribute:

Types of Documentation Contributions

  1. Updating Existing Documentation: If you come across outdated, incomplete, or unclear sections in the documentation, feel free to update it. Ensure that the changes align with the current features or functionalities.

  2. Creating New Documentation: If you notice a missing aspect that would benefit from documentation, such as new features or usage guides, you're welcome to create new documentation sections or pages.

Guidelines for Documentation Contributions

  • Consistency: Maintain consistency in writing style, formatting, and language throughout the documentation.

  • Clarity and Completeness: Ensure the documentation is clear, easy to understand, and comprehensive. Aim to cover all essential aspects related to the topic.

  • Use of Markdown: Write documentation using Markdown format for text formatting. Provide examples, code snippets, and images where necessary.

  • Commit format: Read commit message format for more info.

Your First Code Contribution

Prerequisites

  1. Node.js and pnpm:

  2. Tauri:

  3. Git:

    • Git version control system is necessary for cloning the Inner Ink repository and contributing changes.
    • Git Download

  4. GitHub Account:

    • Have a GitHub account to fork the Inner Ink repository, create issues, and submit pull requests.

Development

Follow these steps to set up the Inner Ink project on your local machine:

  1. Fork the Repository:

    • Fork the Inner Ink repository to your GitHub account by clicking the "Fork" button at the top right of the repository page.

  2. Clone the Forked Repository:

    • Clone the forked repository to your local machine using Git. Replace [YourUsername] with your GitHub username. 
      git clone https://github.com/[YourUsername]/inner-ink.git

  3. Navigate to Project Directory:

    • Move into the Inner Ink project directory: 
      cd inner-ink

  4. Install Dependencies:

    • Run the following command to install project dependencies using Pnpm: 
      pnpm install

  5. Start the Application:

    • Once the dependencies are installed, start the Inner Ink application: 
      pnpm dev
    • This will
      • build the frontend files and serve them on localhost
      • download and build cargo dependencies
      • run Inner Ink locally using Tauri in development mode.

  6. Contribute and Make Changes:

    • You're all set! Start contributing by making changes, adding features, fixing bugs, etc. Make sure to follow the commit format

  7. Creating Pull Requests:

    • When you're ready to contribute your changes, create a pull request from your forked repository to the original Inner Ink repository.

  8. Review and Merge:

    • After creating a pull request, project maintainers will review your changes. Once approved, your code will be merged into the main project.

Commit Message format

We encourage contributors to follow the Conventional Commits specification for writing commit messages. This convention helps standardize commit messages and aids in generating changelogs automatically.

When making contributions to Inner Ink, please format your commit messages following the Conventional Commits specification:

  • Use a short, descriptive summary of your changes in the commit message's first line (limited to 72 characters).
  • Separate the summary from the body of the message with a blank line.
  • Provide detailed explanations or additional context in the commit body if necessary.

Tip: Use pnpm commit command to run commitizen for formatting commits with ease

Examples:

docs: correct spelling of CHANGELOG

fix: prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868

Attribution

This guide is based on the contributing-gen. Make your own!