Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (53 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

83 lines (53 loc) · 2.27 KB
Raw

Contributing to UFBR

Thank you for your interest in contributing to UFBR (Universal File-Based Router).

UFBR is an open-source, framework-agnostic client-side file-based router. Contributions, bug reports, documentation improvements, and ideas are welcome.

Getting Started

Clone the repository and install the dependencies:

git clone https://github.com/zikojs/ufbr.git
cd ufbr
npm install

Before making changes, make sure the project works correctly in your local environment.

Development

Create a branch for your changes:

git checkout -b feature/my-change

Make your changes, then run the available checks and tests before submitting a pull request.

What You Can Contribute

You can contribute to:

  • 🐛 Bug fixes
  • ✨ New features
  • 📚 Documentation
  • 🧪 Tests
  • ⚡ Performance improvements
  • 🔧 Developer experience
  • 💡 Ideas and improvements

Pull Requests

Before opening a pull request:

  1. Make sure your changes are focused and relevant.
  2. Keep the existing project structure and coding style.
  3. Update the documentation when changing or adding functionality.
  4. Add or update tests when appropriate.
  5. Make sure existing functionality is not unnecessarily broken.
  6. Provide a clear description of what your pull request changes and why.

Issues

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

When reporting a bug, include:

  • A clear description of the problem.
  • Steps to reproduce it.
  • The expected behavior.
  • The actual behavior.
  • A minimal reproduction when possible.
  • Relevant environment information.

Documentation

Documentation improvements are especially welcome. If you notice an error, missing explanation, unclear example, or outdated information, feel free to submit a pull request.

Code Style

Please follow the existing coding style and conventions used throughout the project.

Keep changes simple and avoid introducing unnecessary dependencies or abstractions.

Community

Please be respectful and constructive when communicating with other contributors.

By contributing to UFBR, you agree to follow the project's code of conduct and licensing terms.

License

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