> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xreatlabs.space/llms.txt
> Use this file to discover all available pages before exploring further.
# Contributing Guidelines
> Guidelines for contributing to NexAuth development
# Contributing Guidelines
Thank you for your interest in contributing to NexAuth! This document provides guidelines for contributing code, reporting issues, and participating in the project.
## Getting Started
Fork the NexAuth repository on GitHub.
```bash theme={null}
# Fork at https://github.com/XreatLabs/NexAuth
```
Clone your fork locally.
```bash theme={null}
git clone https://github.com/YOUR_USERNAME/NexAuth.git
cd NexAuth
```
Add the original repository as upstream.
```bash theme={null}
git remote add upstream https://github.com/XreatLabs/NexAuth.git
```
Follow the [Building Guide](/nexauth/developers/building) to set up your development environment.
## Contribution Types
### Code Contributions
#### Feature Development
1. **Discuss First**
* Open an issue to discuss the feature
* Get feedback from maintainers
* Plan implementation approach
2. **Implementation**
* Create feature branch: `git checkout -b feature/your-feature`
* Write clean, documented code
* Add tests for new functionality
* Update documentation
3. **Testing**
* Ensure all tests pass
* Test on both Velocity and Paper
* Check for regressions
4. **Pull Request**
* Create descriptive PR
* Reference related issue
* Respond to review feedback
#### Bug Fixes
1. **Report Bug**
* Create issue with detailed information
* Include reproduction steps
* Provide error logs
2. **Fix Implementation**
* Create bugfix branch: `git checkout -b fix/issue-number`
* Write fix with tests
* Document the fix
3. **Verification**
* Test fix thoroughly
* Add regression tests
* Update documentation if needed
### Documentation Contributions
Documentation is crucial for project success!
#### Types of Documentation
* **User Guides** - Installation, configuration, usage
* **API Docs** - Javadoc comments, API reference
* **Developer Docs** - Architecture, building, contributing
* **Examples** - Code examples, use cases
#### Documentation Standards
* ✅ Clear and concise language
* ✅ Step-by-step instructions
* ✅ Code examples where helpful
* ✅ Screenshots for UI features
* ✅ Keep documentation up to date
## Code Style Guidelines
### Java Code Style
Follow these conventions for consistent code style:
```java theme={null}
// Class names: PascalCase
public class AuthenticationManager {
}
// Method names: camelCase
public void authenticatePlayer() {
}
// Constants: UPPER_SNAKE_CASE
public static final int MAX_LOGIN_ATTEMPTS = 5;
// Variables: camelCase
private String playerName;
// Indentation: 4 spaces
// Line length: max 120 characters
```
### Documentation Comments
Use Javadoc for public APIs:
```java theme={null}
/**
* Authenticates a player with the given credentials.
*
* @param username the player's username
* @param password the player's password
* @return AuthResult containing authentication status
* @throws AuthenticationException if authentication fails
*/
public AuthResult authenticate(String username, String password) {
// Implementation
}
```
### Code Organization
```
com.nexauth/
├── core/ # Core functionality
├── velocity/ # Velocity-specific code
├── paper/ # Paper-specific code
├── database/ # Database layer
├── crypto/ # Security and encryption
└── util/ # Utility classes
```
## Commit Guidelines
### Commit Message Format
Follow conventional commits:
```
():