Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

103 lines (74 loc) · 4.27 KB

Contributing

Thank you so much for considering to contribute! Here are useful information about the pages to get you started. Remember you can always ask for help in the discussion or privately through my email: neverrare@proton.me

Issue

The issue page is intended for tracking the development of ilo Token. You may open an issue for:

  • Bug report
  • Feature request

Please remember to search first before opening an issue, it might already exist! Also check the changelog and open the on-development changelog, it might be already fixed but hasn't published yet! Duplicate issues are unnecessary.

Note to maintainer/contributor: When there's a bug discovered, make a test for it if possible. Use Deno's own testing tools: examples. Then edit the issue to link the test in following format:

Test: [src/translator/test.ts "verb with adverb"](permalink including the lines)

Discussion

This GitHub repository have discussion, a dedicated forum page and shall serve as a public space for ilo Token development. You may open a new page for:

  • Suggestion for translation e.g. how it can be improved
  • Questions
  • Any opinions or suggestions you want to share

Please search first before opening a new page! Duplicate pages are unnecessary.

Pull request

Before forking and editing, please claim an issue first or open an issue then claim it. After that, you can start away. This is necessary to avoid wasted duplicate efforts.

You don't have to open a new issue this if:

  • It is a contribution to the dictionary
  • It is a minor edit e.g. a typo fix

Please don't do the following, we can do this ourselves.

  • Updating dependencies

More things to remember:

  • Keep the source code as runtime agnostic as possible. We target the browser and Deno. This is necessary because we use deno test. If a module is exclusive to one runtime, add a note above the code: // This code is browser/Deno only.

(The following aren't strict rules. It's perfectly fine to not follow any of these for any reason e.g. you just want to fix typo.)

  • Ensure all the files are formatted: Run deno fmt.
  • Make sure you don't accidentally make more tests fail: Run deno test --parallel before and after making changes to the code. Some tests may already be failing.
  • Make use of linter: Run deno lint. If a lint rule is deemed unnecessary and more of an annoyance, open an issue. We can remove lint rules.

As a thank you for contributing, you'll get a shout out in the changelog!

Alternative contact options

If you have no github account or want to provide feedback privately, these are alternative contact options:

ilo Token have a dedicated space for the following site. Although these sites themselves serves as a space for broader topics, not just ilo Token.

These are unofficial spaces and are not subject to the Contributor Covenant Code of Conduct. Instead, each have its own rules and different moderators.