- Be kind and understanding.
- It’s a good idea to create an issue before you start coding. This prevents disappointment if your pull request gets rejected.
- Adhere to coding standards.
- Keep commits small. Prevent making unrelated changes.
I try to add tests and achieve 100% code coverage for all of my projects. Some projects are harder to test than others. I’m always open to suggestions on how a project could be tested.
Most of my projects use linters and formatters to ensure a strict coding standard. Typically these tools are ESLint, Prettier, remark, and TypeScript, but they may vary per project. GitHub actions are used to verify the code adheres to these tools.
Please don’t commit files that are related to your local development environment such as editor or operating system files. It is your responsibility to not commit them. It helps to configure a global gitignore. For reference have a look at my global gitignore.
I recommend to use an imperative commit message title starting with an upper case character and to include a body, but I don’t enforce a commit message standard for my own projects.
My open source work is 100% free. However, life is not. If you like my work, please consider sponsoring me via GitHub sponsors.