Thank you for your interest in contributing to Fullwave 2.5!
Please read the following guidelines to ensure a smooth contribution process.
- When developing something new, please create a new branch such as
TYPE/BRANCH_NAME.- TYPE can be
feature,bugfix,hotfix,docs,refactor,release,test, orexperiment. BRANCH_NAMEshould be descriptive of the feature or fix you are working on.- see also: GitHub Branching Name Best Practices
- TYPE can be
- Please write clear and concise commit messages.
- Please keep your branch up to date with the main branch or develop branch.
- we use GitLab Flow for Git branching
- Please make a pull request if you want to add a new feature to the main branch.
- You need to make a pull request to develop branch first, and then to main branch after the code review.
- Please write tests for new features or bug fixes.
- Please use the pre-commit tool to keep the code clean. Pre-commit is installed when you use the make command to install
fullwave-python.pre-commit install
- Ruff will check your code and suggest improvements before you commit.
- Sometimes, however, the fix is unnecessary and cumbersome. Let Masashi know if you want to remove some coding rules.
