search

antonroesler / application-landscape-visualizer

Summer 2021 group project for the module "Advanced Programming" at Frankfurt University of Applied Sciences
1 stars 4 forks source link

readme

Application Landscape Visualizer

Summer 2021 group project for the module "Advanced Programming" of the Engineering Business Information Systems B.Sc. program at Frankfurt University of Applied Sciences.

Read more about what the project does here: https://www.antonroesler.com/application-landscape-visualizer#start

The project is still online but we moved it to a free heroku server, so the web app is not that fast. Deploy: https://application-landscape-vis.herokuapp.com/

Contributors

Rules for Contributors

  1. Before a new feature is developed or a change is made, there must be an issue. If there is no issue: open one. The issue is so that everyone else knows what is happening and can comment on it. Everyone should actively participate in the communication.
  2. For a new feature, create a new local branch - never work on the main branch. Once the feature is ready and the code works, create a pull request. (See GIT workflow)
  3. Your code should be cleanly written and commented as needed.
  4. Your code should be well tested before creating a pull request.
  5. Naming conventions and other style specifications are still to be announced. For JavaScript code, the naming conventions according to https://www.robinwieruch.de/javascript-naming-conventions should be used.

Best Practices for Contributors

  1. A feature should always have its own branch, no two new features in one branch. 2.Naming rule for a commit is #issue Here is a short description e.g. #1 Initial commit. A branch should always contain the feature name and should be descriptive e.g. test/foo. Test is a leading token for categorization. More leading tokens are: feat, bug, test, wip.

GIT Workflow

  1. Clone the project to the local machine.
  2. Creating a branch to develop a feature, debug, test, ...
  3. You then start to work and commit your changes to the new branch. And publish the branch to GitHub.
  4. When you're done, create a pull request on GitHub to contribute your code to the main branch.

File Header

Before you start coding, create a header comment in the new file you created. It is important to think about WHAT you are doing before you start coding. You can find an example header in the misc folder under header.txt.