-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters