Sider Releases Recommended Rules, A Coding Guide Based On Analyzing 1,000 Projects, For Public Use
Sider is a developer and provider of software development support tools. The provider created an optimized recommended coding guide known as ‘Recommended Rules’ which has integrated them into its automated code review service.
By analyzing hundreds of existing coding guidelines, this guide contains only the essential rules followed by many open-source projects and was developed based on joint research.
With Professor Shingo Takada of the Department of Information Engineering, Faculty of Science and Technology, Keio University, and Associate Professor Seigo Nakura of the Department of Software Engineering, Faculty of Science and Technology, Nanzan University. The Recommended Rules are already a part of the default setup of Sider, but the configuration files can also be downloaded separately from the following URL and applied to other linters and analysis engines:
The Recommended Rules were created by extracting coding guides that were being applied to 1,000 well-known and actively developed open-source software projects, and by analyzing source code and its development histories. By applying these new rules, Sider’s automated code review generates suggestions of greater relevance and importance, lending itself to greater productivity for software development efforts.
Programming Languages For Which Recommended Rules Can Be Applied
- Java (will be applied soon)
- Ruby (will be applied soon)
- Ruby (will be applied soon)
- TypeScript (will be applied soon)
Programming Languages To Be Supported
- Shell script
Coding guides were created and published for the purpose of maintaining high code quality in software. Adhering to these rules is expected to provide benefits such as deterring bugs, improving readability and maintainability, and preventing security vulnerabilities. However, the rules set forth in these various coding guides also have varying degrees of importance.
For example, in programming languages where ” and can be utilized equally, there are guides that include rules that specify which one should be used in principle. While following the rules during development is expected to make things easier for the development team, it is not clear whether applying these rules to code that is already completed is worth the effort. In some teams/projects, the decision is made not to unify as it does not contribute to productivity.
Recommended Rules was created as a coding guide that is useful for any project. By first introducing this guide into a project, and then enabling other necessary rules according to the project, it will be easy to set up and operate the guide according to the project.
In creating Recommended Rules, Sider collaborated with Professor Shingo Takada of the Department of Information Engineering, Faculty of Science and Technology, Keio University, and Associate Professor Seigo Nakura of the Department of Software Engineering, Faculty of Science and Technology, Nanzan University. Research content is scheduled to be released in the form of research papers.
Reference papers, posters, etc.
- Toru Kurashige, Kentaro Suetsugu, Koichiro Sumi, Masataka Nagura, Shingo Takada, Akihiro Asahara: A Survey of Coding Convention Violations in OSS, Software Engineering Symposium 2020 (SES2020), Poster Session (September 2020)
- Masataka Nagura, Kensuke Taguchi, and Shingo Takada: A Method for Predicting Defects in Software Changes Based on Coding Convention Violation Metrics, Transactions of Information Processing Society of Japan, Vol. 61, No. 4, pp. 895-907 (Apr. 2020) (in Japanese).
Joint research partners
- Shingo Takada, Professor at Takata Laboratory, Department of Information Engineering, Faculty of Science and Technology, Keio University
- Masatake Nagura, Associate Professor at Department of Software Engineering, Nanzan University
Recommended Rules, an optimized recommended coding guide, was developed by Sider Corporation based on joint research with Professor Shingo Takada of the Department of Information Engineering, Faculty of Science and Technology, Keio University, and Associate Professor Seigo Nagura of the Department of Software Engineering, Faculty of Science and Technology, Nanzan University. The responsibility for providing this guide rests with Sider.
Sider Corporation was established in 2019 as a product development company in the field of software development and is a spin-off from Fixstars Corporation, a global leader in software acceleration services. Since its inception in 2002, Fixstars has been providing powerful software acceleration solutions to global companies and research institutions in various fields such as automated driving, quantum computing, medical devices, financial systems, and computer graphics. With the experience of these client projects, Sider Corporation provides Sider, an automated code review service, and Sider Team Insights, a project management assistant tool.
Sider Corporation is committed to improving the development experience for all engineers by realizing a world where AI and people collaborate in software development.