Skip to content

docs: fix all instances of initialise and other non-americanenlish spellingstypo/spelling for all instances of initialise #811

Open
@theekrystallee

Description

@theekrystallee

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hiero or any open source project in general. We know that creating a pull request (PR) is a major barrier for new contributors. The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hiero.

👾 Description of the issue

The documentation has instances of initialise spelled in British English.
Fix these spellings to American-English to comply with the style guide and to maintain the same tone and style throughout the documentation.

✅ Proposed Solution

Here are the docs where I found the initial batch

📋 Step-by-step guide to Contribute to Hiero

If you have never contributed to an open-source project at GitHub, the following step-by-step instructions will introduce you to the workflow.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org/). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hiero developer community for support.
  • Wait for reviews: Members of the Hiero developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.

You did it 🎉:

Note

More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file. A more detailed general documentation of the GitHub PR workflow can be found here.

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join ask any question at our GitHub discussions. A general manual about open-source contributions can be found here.

Thanks for contributing to Hiero!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueIndicates a good issue for first-time contributors

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions