Skip to main content

Contribution Guidelines

Thank you for your interest in contributing to the Tower Defense project! This guide provides instructions on how to contribute effectively.

1. Code of Conduct​

Please be respectful and follow our project's Code of Conduct. Ensure a positive and inclusive environment for all contributors.

2. Setting Up for Development​

Refer to the Getting Started guide to set up your local development environment.

3. Creating a Pull Request​

We follow a standard Git workflow:

  1. Fork the repository: Create a copy in your own account.
  2. Create a branch: Use descriptive branch names like feat/new-tower, fix/login-bug, or docs/update-readme.
  3. Make changes: Commit small, logical changes with clear commit messages.
  4. Push changes: Push your branch to your fork.
  5. Open a PR: Create a pull request to the main branch of the original repository.

4. Coding Standards​

  • Naming Conventions: Use camelCase for variables and PascalCase for classes/components.
  • Linting: Ensure your code passes linting checks with pnpm nx lint <project-name>.
  • Testing: Include unit tests for new features.

5. Documentation Contributions​

  • Documentation is located in apps/docs.
  • Follow the Diátaxis framework for new articles.
  • Use MDX for interactive components or Mermaid for diagrams.

6. Security Reports​

If you discover a security issue, please report it privately via email. See Security for details.

tip

Always pull the latest changes from the main branch before starting work on a new feature or bug fix.