Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

48 lines (38 loc) · 1.6 KB

Contributing to Ulka

Ulka is an open source project, and contributions of any kind are welcome and appreciated. We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Please note we have a code of conduct, please follow it in all your interactions with the project.

Issues

If you encounter a bug, please file a bug report. If you have a feature to request, please open a feature request. If you would like to work on an issue or feature, there is no need to request permission. Please add tests to any new features.

Pull Requests

In order to create a pull request for ulka, follow the GitHub instructions for Creating a pull request from a fork. Please link your pull request to an existing issue.

Folder Structure

Description of the project files and directories.

📦ulka
┣ 📂bin
┃ ┗ 📜index.js
┣ 📂src
┃ ┣ 📂server
┃ ┃ ┣ 📜index.js
┃ ┃ ┗ 📜server.js
┃ ┣ 📂ulka-cli
┃ ┃ ┣ 📜build.js
┃ ┃ ┣ 📜create.js
┃ ┃ ┗ 📜serve.js
┃ ┣ 📂utils
┃ ┃ ┣ 📜build-utils.js
┃ ┃ ┣ 📜helpers.js
┃ ┃ ┣ 📜ulka-fs.js
┃ ┃ ┗ 📜ulka-log.js
┃ ┗ 📜index.js
┣ 📂tests
┃ ┣ 📂e2e
┃ ┗ 📂unit

License

By contributing, you agree that your contributions will be licensed under its MIT License.