Contributing to LOC's Community Relations Alpha Edition System

Thank you for considering contributing to this project! Your contributions are highly valued, and we’re excited to collaborate with you.

This guide outlines the process for contributing code, reporting issues, and adhering to code quality standards using ESLint and Prettier.

Getting Started

Fork the Repository: Click the "Fork" button at the top of this repository to create your own fork.
Clone Your Fork: Clone the repository to your local environment.

git clone https://git.site.com/your-username/project-name.git
Navigate to the Project Directory:

cd project-name

To install all necessary project dependencies, run: npm install

We use ESLint for linting and Prettier for consistent code formatting. Please ensure your code follows these standards.

ESLint is configured to catch potential errors and enforce coding standards.

Configuration File: eslint.config.mjs
Plugins: Includes @typescript-eslint for TypeScript-specific rules and prettier to ensure Prettier rules are respected.

Prettier is used for automatic code formatting to maintain a consistent style across the codebase.

Configuration File: .prettierrc
Integration: Integrated with ESLint, so running eslint will also check for Prettier formatting issues.

Create a Branch: Create a new branch for your work.

git checkout -b feature/your-feature-name
Make Your Changes: Edit files, add features, or fix bugs as needed.
Run Tests: Ensure all tests pass.

Tests may not be active for the project, please check with Maintainer.

npm test
Linting and Formatting: Run ESLint and Prettier before committing.

npm run lint npm run format

To automatically fix linting issues: npm run lint:fix

We use Husky and lint-staged to automate linting and formatting checks before each commit. Install these with:

npm run prepare

This will set up Git hooks to automatically check your code before committing.

Push to Your Fork:

git push origin feature/your-feature-name
Open a Pull Request:
- Go to the original repository on Git.
- Click on New Pull Request.
- Select your branch and provide a clear description of your changes.
Address Feedback: The project maintainers may review and provide feedback. Please address any requested changes.

If you have questions or need assistance, feel free to reach out by opening an issue. We're here to help!

This project is managed and maintained by the Library of Code Department of Engineering. We can be reached in our Discord server or via Email.

Thank you for contributing!