Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.38 KB

developer-guide.md

File metadata and controls

56 lines (37 loc) · 1.38 KB

🧑‍💻 Developer Guide

This guide helps you get started developing nubarchiva.

Dependencies

Before you start contributing to nubarchiva, make sure you have the following tools and programming languages installed.

Required tools:

  • git

Required programming languages:

  • Java 11
  • Maven 3.5.0+

How to run in your local environment

Run the following command to build this project:

mvn clean verify

Pass the -Dquick option to skip all non-essential plug-ins and create the output artifact as quickly as possible:

mvn clean verify -Dquick

Run the following command to format the source code and organize the imports as per the project's conventions:

mvn process-sources

Run the following command to add license header info:

mvn -Pcode-format generate-sources

Git workflow basic

Here's a general nubarchiva git workflow:

  1. Create an issue and describe features you want -> nubarchiva issues
  2. Fork this project -> Fork nubarchiva project
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some features')
  5. Publish the branch (git push origin my-new-feature)
  6. Create a new Pull Request -> Create pull request across forks