Skip to content

Contributing

Illia Kotvitskyi edited this page Feb 18, 2025 · 2 revisions

We welcome contributions to the FBI Agent Management Game! To contribute, please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Code Guidelines

  • Follow coding standards: Adhere to project coding conventions.
  • Write tests: Ensure new features and bug fixes are covered with unit/integration tests.
  • Document your changes: Update relevant documentation (e.g., README, Wiki) if necessary.
  • Stay up-to-date: Sync with the latest main branch before submitting your PR.
    git pull origin main

Pull Request Process

  1. Ensure all existing and new tests pass.
  2. Provide detailed descriptions of the changes in the PR.
  3. Be ready for feedback: Address any comments or requested changes by reviewers.

Reporting Issues

  • Please check the issue tracker before submitting new issues to avoid duplicates.
  • Include as much detail as possible, such as platform, browser, and steps to reproduce the issue.

Clone this wiki locally