wamikabro / ConsolePatternsLibrary

Your all-in-one library that contains all the patterns that you would love to visualize in your console window. Your contributions are welcomed. Together we build beautiful patterns. (Only Java is supported at the moment).

ConsolePatternsLibrary

Your all-in-one library that contains all the patterns that you would love to visualize in your console window.
All you need to do is download this library, import Java.* in your code, and then you can use JavaPatterns. class name to call any pattern you want. List of the names and visuals of the pattern are in JavaPatternsList.md, and you can also see the names when recommended after typing "JavaPatterns." in your IntelliJ/VisualStudio (Or any other IDE). Your contributions are welcomed. Together we build beautiful patterns.

Note: Before Committing, must read How to Contribute?, Supported Languages and Contribution Rules.

Supported Languages

1. Java
(We've temporarily removed python support.)

How to Contribute?

1. Make sure no similiar issue/pull request is open. If similar issue is open, you can comment on it to get the permission to work on that pattern (Only if the author of the issue haven't mentioned that he wants to add the pattern himself).
2. Open an Issue describing your idea of pattern also tell the language you wanna work on (Supported languages are mentioned above).
3. Showing result image of pattern (if possible). Keep it as small as possible in demonstration eg. Square pattern of 5x5 instead of 10x10)
4. Mention that you want to do it yourself in the issue.
5. Fork the repository.
6. Clone your forked repository and work on your pattern.
7. Open a Pull Request once you're done.

Rules and Guide to Contribution

1. Make sure the language you're going to use is present in supported languages section above.
2. Make sure pattern isn't already available in the same language.
3. Pattern must not contain nudity, racism or hate visuals (Country or Ethnic Flags are allowed).
4. Make sure to add single pattern in single contribution. You're welcomed to do multiple contributions.
5. Pattern must be dynamic. Even if it's based on different dimensions, it must take some sort of size as input.
6. Make default access class with your Pattern's Method name in pascal case inside Java package. (pattern's method name is defined in details below).
7. Pattern must be made inside a protected static void type method.
8. Method name should be pattern().
9. Method should contain single pattern.
10. You can use multiple private methods to support your protected method.
11. You can use asteric(stars), numbers, symbols and alphabets (and their mixture) in the pattern. (Basically all the ascii supported characters)
12. Only For loop from the loops and its variations are allowed.
13. Temporarily make main method and call your method inside it to verify it's working fine and screenshot the output.
14. Call your method inside another public method in JavaPatterns.java class present in the Java package (Let's call this method Pattern's method). (make sure to pass all the parameters respectively from the newly created method to the method that you called.
15. Pattern's Method name should be in Camel Case.
16. Pattern's Method name should be in this format
    [DataType] [PatternType] [Idea] eg. numberedHollowTriangle(). (You can get an idea from the already written code above in the file).
    DataType = Numbered / Alphabetic / Symboled / Mixed Default: Asterisk (No need to mention it)
    PatternType = Solid / Hollow / Mixed
    Idea = Meaningful Name for your idea. (Use pascal case for compound words eg. PakistaniFlag)
17. Add the Pattern's Method name, Signature and Screenshot of the result. (You can get an idea from the already written code above in the file).

You will get an idea easily after forking and then cloning the repository. Every default class contains documentation that will help you work.

Thanks for the contribution in advance!