CONTRIBUTING.md

Contributing

Current tasks to be completed

• Parallax Navigation Drawer for Jetpack Compose.

• Save state of drawer when configuration changes.

• Have a new feature in mind?

• Want to make changes and improvements to documentations and code?

• Noticed an error?

• Found a bug?

Contributions are welcome and encouraged!!

Make a fork of the repository and send a pull request.

Discussions about your code, logical decisions and proposed changes would be made before pushing to the main repository branch.

Concerning Issues

• Before creating an issue, please verify if a pre-existing and similar issue already exists.
• If an issue is closed and problem persists, you can reopen that same issue or create an entirely new issue.
• Persistent bugs can be better illustrated using a unit/integrated test, demo project, JPG/JPEG file, GIF animation, stack traces and logs.

NOTE: When posting code blocks, logs or stack traces etc, please use Github flavoured markdown syntax to improve readability.

For Kotlin code blocks, KDoc comments with KDoc syntax are preferable.

Concerning Code Style

Consistent indentation plays an important role in readability and maintainability of code. The indentation currently used in this project is as follows:

fun correctIndent() {
	doSomethingHere {
		val x = "some string var"
	}
}

Wrong indentation:

fun inCorrectIndent() 
{
	doSomethingHere 
	{
		val x = "some string var"
	}
}

Please follow the correct indentation style.