Skip to content

Latest commit

 

History

History
150 lines (102 loc) · 6.51 KB

CONTRIBUTING.md

File metadata and controls

150 lines (102 loc) · 6.51 KB
Raw

Contributing to Wanakana

Love Wanakana and want to help?

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Install dependencies from package.json

Install node LTS and yarn, then install deps via yarn shell command.

Linting & Formatting

Recommend using an eslint addon for your code editor that can reference the .eslintrc config. Files will be formatted using prettier during commit, so many errors will be fixed automagically anyway. Any leftover linting errors will be displayed after formatting and will need to be corrected. After fixing, you can re-use your commit message details with yarn cz --retry.

Useful build scripts

  • yarn test Run Tests or yarn test:watch for continuous development, or yarn test:view to open in browser
  • yarn docs Build docs or yarn docs:watch for continuous development, or yarn docs:view to open in browser
  • yarn build Build distribution bundles (note: this will still be done automatically during release)

Committing

Please use yarn cz for standardized commit messages! Update CHANGELOG.md with any changes, following the format provided.

Publishing new versions

If you have NPM Publish authority for the project you can run npm run release (yarn has an issue with npm auth) and follow the prompts. This will lint, test, build packages, docs, demo website, publish to npm, update tags as new release on github, as well as push the website/docs with updated bundle to gh-pages branch. Afterwards, you can generate release notes on github by drafting a new release using the newly added version tag.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome. But take a moment to 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. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Since the master branch is what people actually use in production, we have a dev branch that unstable changes get merged into first. Only when we consider that stable we merge it into the master branch and release the changes for real.

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/WanaKana.git
# Navigate to the newly cloned directory
cd WanaKana
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/WaniKani/WanaKana.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout dev
git pull upstream dev

  3. Create a new topic branch (off the dev branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream dev branch into your topic branch:

    git pull [--rebase] upstream dev

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.