My Basic Contributing.md

Contributing.md

Annotations & JavaDocs

• When you alter a class, please add an @author annotation to the class.
• Adding @author annotations to methods is optional.
• Adding JavaDocs is optional.

How can I help?

Internal Contributors

1. Clone the project. You can do this with git by typing "git clone https://github.com/Mr-Deej/repo".
2. Create a new branch before altering any code.
3. Alter the code.
4. Open a pull request here.

External Contributors

1. Fork the project.
2. Create a new branch. (optional)
3. Alter the code.
4. Open a pull request here.

Questions

There are a number of issues open which pose a question. Feel free to contribute to any ongoing discussions.

What should I work on?

Guided

• Want to fix some stuff? You can find bugs to fix here.
• Want to improve the library? You can find planned improvements here.
• Want to implement a new feature? You can find planned features here.

Unguided

• If you find a flaw in the code or a bug, please create an issue here.
• If you see a way for the code to be improved, feel free to create an issue here and tell us about it.
  • If you're feeling especially motivated, you're welcome to implement your idea(s) and submit a PR here.

Notes

• Java 16 can be used to build the project.