Skip to content

Commit

Permalink
Develop branch merge to master (#5)
Browse files Browse the repository at this point in the history
* Readme file added (#1)

* Create README.md

Added new readme.md file

* Update README.md

* Removed unnecessary dependencies from pom.xml (#2)

* Removed unnecessary dependencies from pom.xml, added crypto.utils to resolve build issues

* pom.xml cleanup

* updated code-of-conduct, copying, contributing, readme (#3)

* Create CONTRIBUTING.md

* Create CODE_OF_CONDUCT.md

* Create COPYING

* Update README.md

* modified .gitignore file (#4)

* modified .gitignore file

* Delete target directory

* Update .gitignore

* Delete logs directory

---------

Co-authored-by: Mahima Elizabeth George <[email protected]>
Co-authored-by: Sweta Prakash <[email protected]>
Co-authored-by: Vidyadevi Salunkhe <[email protected]>
  • Loading branch information
4 people authored Jun 12, 2023
1 parent 400581b commit 817f37c
Show file tree
Hide file tree
Showing 22 changed files with 1,036 additions and 794 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/build-on-pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Build On Pull Request
on:
pull_request:
branches: [ "master","develop" ]

jobs:
Build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.ref }}
repository: ${{ github.event.pull_request.head.repo.full_name }}

- name: Setup JDK 8
uses: actions/setup-java@v2
with:
java-version: 8
distribution: 'adopt'
- name: Build with Maven
run: mvn clean install
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
name: Build and Deploy
name: Static Code Analysis and Packaging
on:
push:
branches: [ "master","develop" ]
pull_request:
branches: [ "master","develop" ]

jobs:
build:
CodeQL:
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
steps:
- name: Checkout code
uses: actions/checkout@v2


- name: Setup JDK 8
uses: actions/setup-java@v2
with:
java-version: 8
distribution: 'adopt'


- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: Java


- name: Build with Maven
run: mvn clean install


- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
languages: Java


Packaging:
needs: codeql
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Setup JDK 8
uses: actions/setup-java@v2
with:
java-version: 8
distribution: 'adopt'
- name: Create WAR file
run: mvn -B package --file pom.xml


- name: Upload WAR file as artifact
uses: actions/upload-artifact@v2
with:
name: Identity-API
path: target/identity-0.0.1.war

11 changes: 9 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#Ignore target and logs
target/
!.mvn/wrapper/maven-wrapper.jar
logs/

### STS ###
.apt_generated
Expand All @@ -8,6 +9,7 @@ target/
.project
.settings
.springBeans
.sts4-cache

### IntelliJ IDEA ###
.idea
Expand All @@ -21,4 +23,9 @@ build/
nbbuild/
dist/
nbdist/
.nb-gradle/
.nb-gradle/

### Other Entries ###
mvnw
mvnw.cmd
.mvn
Binary file removed .mvn/wrapper/maven-wrapper.jar
Binary file not shown.
1 change: 0 additions & 1 deletion .mvn/wrapper/maven-wrapper.properties

This file was deleted.

1 change: 0 additions & 1 deletion .sts4-cache/classpath-data.json

This file was deleted.

132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to AMRIT

AMRIT is released under the GPLv3 license. If you would like to contribute something, or want to hack on the code this document should help you get started.

# Code of Conduct
This project adheres to the [Contributor Covenant](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

# Using GitHub Issues
We use GitHub issues to track bugs and enhancements reported by the community.
If you have a general usage question please ask on [email protected].

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
Ideally, that would include a small sample project that reproduces the problem.

# Reporting Security Vulnerabilities
If you think you have found a security vulnerability in AMRIT please *DO NOT* disclose it publicly until we've had a chance to fix it.
Please don't report security vulnerabilities using GitHub issues, instead drop an email to [email protected] by providing as much as information as possible.

# Code Conventions and Housekeeping
None of these are essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

* Make sure all new `.java` files have a Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for.
* Add the GPLv3 boilerplate notice (license header comment) to all new `.java` files (copy from existing files in the project).
* Add yourself as an `@author` to the `.java` files that you modify substantially (more than cosmetic changes).
* Add some Javadocs.
* A few unit tests would help a lot as well -- someone has to do it.
* If no-one else is using your branch, please rebase it against the current main branch (or other target branch in the project).
* When writing a commit message please follow [these conventions](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

# Working with the Code
For information on editing, building, and testing the code, see the [developer guide](https://psmri.github.io/PSMRI) page on the project wiki.
Loading

0 comments on commit 817f37c

Please sign in to comment.