Skip to content
This repository has been archived by the owner on Jul 22, 2021. It is now read-only.

Latest commit

 

History

History
66 lines (40 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 3.01 KB
Raw

Contributing to Fontlet project

Fontlet is a free software project hosted on Github and runs the typical free software way. We'd love to accept your patches and contributions to the project. If you wish to contribute, please read this first.

This project welcomes non-code contributions, too! The following types of contributions are welcome:

  • Ideas: Participate in an issue thread or start your own to have your voice heard.
  • Writing: Contribute your expertise in an area by helping expand the included documentation.
  • Copy editing: Fix typos, clarify language, and improve the quality of the documentation.
  • Formatting: Help keep docs easy to read with consistent formatting.
  • Translating: Help to translate the app UI, documentation or the website.

Reporting bugs

Create an issue with clear description, steps to reproduce, screenshots and other necessary information that might help developers to reproduce the problem and fix it.

Apply relevent labels as bug, and the platform: platform:win, platform:darwin, platform:linux, platform:all.

Translations

We do not have internationalisation in place yet.

Documentaion

Update documentation and send PRs. 🙂

Writing code

Are you interested in writing code for this project? Awesome!

We use the following technologies and tools,

  • NodeJs
  • Electron
  • ReactJS (CRA)
  • Styled Components
  • BlueprintJS
  • ESLint/ Prettier

We use GitHub Issue Tracker for most of the developmente related communications. You can also join our Riot.im Community for high bandwidth discussion.

Code Style

For code styling, we use the Airbnb Style Guide and Prettier.

Rules

There are a few basic ground-rules for contributors:

  1. No --force pushes to master or modifying history in any way. Rebasing and force pushing your own PR branch is fine.
  2. Non-master branches should be used for ongoing work.
  3. Significant modifications like API changes should be subject to a pull request to solicit feedback from other contributors.
  4. Pull requests are encouraged for all contributions to solicit feedback but left to the discretion of the contributor.

Developing features and fixing bugs

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. Please create an issue (if not one already created) when you start working on a feature/bug. Also, put a comment that mentioned you are working on that to avoid duplicate efforts.

Please don't create any new labels. If you think it's nice to have or must have a new label, please create a new issue or put it in the comments on a relevant thread. That'll help us to keep a clean and efficient workflow.

External Resources