Skip to content

OpenSourceCleaning/Playground

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BCH compliance

Playground for Open Source Spring Cleaning

Use this repo as a playground for Open Source Spring Cleaning

About The Playground Code

There is a pom.xml file in the root of this repository. This allows compiling the Java source files and running the unit tests using Maven by executing mvn test.

PlayGround Usage

  • Sign in to GitHub (create an account if neccesary)
  • Fork this repository to your own account.
  • Clone the project on your development machine (git clone https://github.com/YourAccountNameHere/playground.git)
  • Open the project in your favorite Java IDE.
  • Try to improve this Playground codebase to a 10/10 from the current 6/10

Use Better Code Hub to find refactoring candidates

  • Go to BetterCodeHub.com and log in [FREE] with your GitHub account.
  • Run and analyze the Playground repository with BetterCodeHub.
  • Refactor the code to comply with the first four guidelines.
  • Commit your local changes (git add *, git commit -m "your comment here").
  • Push the changes to your Github repository (git push).
  • Run the analysis in BetterCodeHub.com to check the results.
  • Add the BCH badge to the README.md to show your compliance

About Building Maintainable Software

This Playground code is based (we pruned the original) on the example code that accompanies Building Maintainable Software: Ten Guidelines for Future-Proof Code by Joost Visser.

There are currently two editions of Building Maintainable Software:

Both editions are the same except for the language of the code snippets and a bit of language-specific terminology (e.g., 'Eclipse' in the Java edition is 'Visual Studio' in the C# edition).

Training videos are also available via O'Reilly Media.

Releases

No releases published

Packages

No packages published

Languages

  • Java 54.5%
  • C# 45.5%