Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.1 KB
Raw

Contributing

Fumi-no is completely open source and contribution to this tool is highly encouraged for everyone! If you have found any issues during your usage of this program, please submit an issue and I'll go back to you right away.

In order to contribute to this project as a programmer, please follow these style guide and workflow.

Project Structure

The project is structured as follows (top-level only):

  • .github for CI/CD.
  • components for the components that compose a single page.
  • db for a sample data.
  • pages to store the available pages in the application.
  • public to store public files.
  • styles to store custom styles (in SCSS).
  • types to store custom types.
  • utils for utility functions.

Coding Style Guide

Please follow this for the sake of the code to be as readable and maintainable as possible.

  • Use your best spelling and punctuation, in English.
  • Before you submit your pull request, ensure that you run the following procedures.
# manual
yarn format-check
yarn eslint-check
yarn type-check

# automatic
yarn lint

Commit Style Guide

Please use Semantic Commit Messages, but with the first letter capitalized. For further details, please check this gist and this website. Using these kinds of commit messages will make contributors into better programmers because of its rigid style. Another reason of using it is because its rigid style actually forces contributors to not commit lots of files in one setting.

Workflow

In order to contribute to this project, please create an issue about the problem that you are going to fix / add. After that, follow these instructions below.

  • Fork the repository.
  • Create a new branch based on the issue number that you created beforehand. Example: git checkout -b issue-10.
  • Make sure to update the CHANGELOG.md, and the version number in package.json.
  • Commit and push your features / changes.
  • Create a new pull request.