Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 8.33 KB

CONTRIBUTING.md

File metadata and controls

127 lines (90 loc) · 8.33 KB
Raw

Welcome to Manaba Plus contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Manaba Plus ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Development

手順

  1. Node.jsをインストールします
  2. このリポジトリをクローンします
    git clone https://github.com/kajikentaro/manaba-plus
  3. ディレクトリを移動します
    cd manaba-plus
  4. npm の依存関係をインストールします
    npm install
  5. 開発用のビルドを行います
    npm run watch
    build ディレクトリの中に結果が格納されます.
  6. インストール
    Chromeの拡張機能設定画面から Developer mode を ON にし、build ディレクトリをドラックアンドドロップします。
  7. Hacking.
  8. 本番用ビルドを行います
    npm run build
    build.zip が生成されます. Warning や Error が出ていないことを確認します.
  9. 良い機能ができたらプルリクエストを送ってください

各ファイルについて

  • src/
    src直下の各 ts ファイルは、Manaba-Plus の機能をそれぞれ 1 つずつ担っています。詳細はファイル先頭のコメントを確認してください
  • src/module/
    src/*.tsから使用するモジュールです
  • public/
    画像や html ファイルなど, Webpack でコンパイルを行わないファイルを配置します.buildディレクトリに直接コピーされます.
  • public/manifest.json
    Chrome 拡張機能の設定ファイルです.
  • .eslintrc.js
    ESLint の設定ファイルです
  • tsconfig.json
    TypeScript の設定ファイルです
  • config/
    Webpack の設定ファイルです.

Issues

Make Changes

Make changes in the UI

Click Make a contribution at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Make changes in a codespace

For more information about using a codespace for working on GitHub documentation, see "Working in a codespace."

Make changes locally

  1. Fork the repository.

  1. Install or update to Node.js, at the version specified in .node-version. For more information, see the development guide.

  2. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the GitHub docs.

Now that you are part of the GitHub docs community, see how else you can contribute to the docs.

Windows

This site can be developed on Windows, however a few potential gotchas need to be kept in mind:

  1. Regular Expressions: Windows uses \r\n for line endings, while Unix-based systems use \n. Therefore, when working on Regular Expressions, use \r?\n instead of \n in order to support both environments. The Node.js os.EOL property can be used to get an OS-specific end-of-line marker.
  2. Paths: Windows systems use \ for the path separator, which would be returned by path.join and others. You could use path.posix, path.posix.join etc and the slash module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
  3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write scripts in JavaScript instead of Bash.
  4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with msys. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include:
    • Update Git configuration: git config --system core.longpaths true
    • Consider using a different Git client on Windows