Skip to content

Commit

Permalink
fix: add code of conduct (#208)
Browse files Browse the repository at this point in the history
  • Loading branch information
csuvajit authored Jan 13, 2025
1 parent 558e74c commit 81a1a81
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone.

## Our Standards

Examples of behavior that contributes to a positive environment:

* Being respectful of differing viewpoints and experiences
* Accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior:

* The use of sexualized language or imagery
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information without permission
* Other conduct which could reasonably be considered inappropriate

## Enforcement

Project maintainers are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 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.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
- [Documentation](https://clashofclans.js.org/docs/)
- [Clash of Clans Developer Website](https://developer.clashofclans.com/)
- [Clash of Clans API Community Discord](https://discord.gg/Eaja7gJ)
- [Contributing Guidelines](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)

### Examples

Expand Down

0 comments on commit 81a1a81

Please sign in to comment.