Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.16 KB

Contributing to clashofclans.js

We love your input! We want to make contributing to clashofclans.js as easy and transparent as possible.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/clashofclans.js.git
  3. Create your feature branch: git checkout -b feature/my-feature
  4. Make your changes
  5. Test your changes: npm test
  6. Commit your changes: git commit -am 'Add some feature'
  7. Push to the branch: git push origin feature/my-feature
  8. Submit a pull request

Pull Request Guidelines

  1. Update the README.md with details of changes to the interface, if applicable
  2. Update the documentation if you're adding or changing functionality
  3. Ensure the test suite passes
  4. Make sure your code follows the existing code style
  5. Include adequate tests

Development Setup

  1. Install dependencies: npm install
  2. Run tests: npm test
  3. Run linting: npm run lint

Code Style

  • Follow the existing code style
  • Use 4 spaces for indentation
  • Use semicolons
  • Write clear commit messages

License

By contributing, you agree that your contributions will be licensed under the project's LICENSE file.