Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (45 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 1.47 KB

Contributing to minecraft-api

Thank you for your interest in contributing to minecraft-api! We welcome all contributions, whether bug reports, feature requests, documentation improvements, or code.

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/minecraft-api.git
cd minecraft-api

3. Install Dependencies

npm install

4. Create a Branch

Create a new branch for your feature or bugfix:

git checkout -b my-feature

5. Make Your Changes

Edit the code, add tests if needed, and ensure everything builds:

npm run build

6. Format Your Code

Format your code using Prettier:

npm run format

7. Commit and Push

git add .
git commit -m "Describe your change"
git push origin my-feature

8. Open a Pull Request

Go to your fork on GitHub and open a pull request against the main branch of the upstream repository.

Guidelines

  • Follow the Code of Conduct.
  • Write clear, concise commit messages.
  • Add or update documentation as needed.
  • Ensure your code passes CI and builds successfully.

Reporting Issues

If you find a bug or have a feature request, please open an issue.

Thank you for helping make minecraft-api better!