Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (58 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

92 lines (58 loc) · 1.9 KB

Contributing to JsonApi4j

Thanks for your interest in contributing! 🎉
I do welcome all kinds of contributions — code, issues, documentation, design, and more.

🧭 How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page.

2. Clone Your Fork

git clone https://github.com/MoonWorm/jsonapi4j.git
cd jsonapi4j

3. Create a New Branch

git checkout -b my-feature-branch

4. Make Your Changes

Make sure your changes follow the project’s coding conventions (see below).

5. Commit Your Changes

git add .
git commit -m "Add: A meaningful commit message"

6. Push to Your Fork

git push origin my-feature-branch

7. Open a Pull Request

Go to the original repository and open a Pull Request from your forked branch. Please include a clear description of what your change does and why it's needed.

✅ What to Contribute

You can help me with:

  • 🐛 Reporting or fixing bugs
  • 📚 Improving documentation
  • ✨ Suggesting or adding features
  • 🧪 Writing or improving tests
  • 🎨 Provide Developer feedback

by creating a thread in a GitHub's discussions

🧼 Code Style Guidelines

  • Keep commits focused and descriptive
  • Use clear, consistent naming
  • Follow language-specific conventions (Java)
  • Use terms from JSON:API, OAS, and other specification that are used in the project
  • Run default Java formatter before pushing

🧪 Running the Project Locally

The framework can be built by using Maven, simply run:

mvn clean install

📄 License

By contributing, you agree that your contributions will be licensed under the same license as the project.

💬 Questions?

Feel free to open an issue or start a discussion in GitHub.