Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/redirect_issues_to_project_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Please read
about: Please do not create issues on this repository, but use the projectmanagement repository instead.
title: ''
labels: ''
assignees: ''

---

## Please redirect issues to Galasa's 'projectmanagement' Repository
Please raise your issue(s) on [Galasa's projectmanagement repository](https://github.com/galasa-dev/projectmanagement/issues).
10 changes: 10 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Security Policy

## Supported Versions

Please upgrade to the latest version of Galasa to recieve security updates.
You can get the latest galasactl binaries [here](https://github.com/galasa-dev/galasa/releases/latest).

## Reporting a Vulnerability

To report a vulnerability, [please contact a maintainer](https://github.com/orgs/galasa-dev/teams/org-owners), [raise a bug report](https://github.com/galasa-dev/projectmanagement/issues) or reach out to us on the [galasa-users](https://openmainframeproject.slack.com/archives/C05ST4K4K54) slack channel on the [Open Mainframe Project Slack org](openmainframeproject.slack.com).
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Why?

Refer to [link-to-github-issue].

<!-- Provide a brief description of your changes -->

## Changes
- [ ] ...
90 changes: 90 additions & 0 deletions CODE_OF_CONDUCT.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Contributor Covenant 3.0 Code of Conduct

## Our Pledge

We pledge to make our community welcoming, safe, and equitable for all.

We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.

## Encouraged Behaviors

While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.

With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:

1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
2. Engaging **kindly and honestly** with others.
3. Respecting **different viewpoints** and experiences.
4. **Taking responsibility** for our actions and contributions.
5. Gracefully giving and accepting **constructive feedback**.
6. Committing to **repairing harm** when it occurs.
7. Behaving in other ways that promote and sustain the **well-being of our community**.


## Restricted Behaviors

We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.

1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
7. Behaving in other ways that **threaten the well-being** of our community.

### Other Restrictions

1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.


## Reporting an Issue

Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.

When an incident does occur, it is important to report it promptly. To report a possible violation, **[please contact one of the maintainers](https://github.com/orgs/galasa-dev/teams/org-owners), or reach out on the [galasa-users slack channel](https://openmainframeproject.slack.com/archives/C05ST4K4K54).**

Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.


## Addressing and Repairing Harm

****

If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.

1) Warning
1) Event: A violation involving a single incident or series of incidents.
2) Consequence: A private, written warning from the Community Moderators.
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
2) Temporarily Limited Activities
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
3) Temporary Suspension
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
4) Permanent Ban
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
3) Repair: There is no possible repair in cases of this severity.

This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.


## Scope

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


## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).

Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)

For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
102 changes: 102 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Contributing

Welcome to Galasa's webui! To learn more about contributing to the Galasa project, please read this Contributor's Guide.

## How can you contribute?

### Reporting bugs

- Search existing issues to avoid duplicates.
- Include clear and concise steps on how to reproduce the bug.
- Provide relevant details, such as your Galasa version and details about environment.
- Raise bugs [here](https://github.com/galasa-dev/projectmanagement/issues).

### Suggesting features

- Open an issue and include a user story, background if relevant, and task list.
- Provide a clear description of the feature.
- Explain why it would be beneficial and how it aligns with the project's goals.
- Raise feature suggestions, as user stories, [here](https://github.com/galasa-dev/projectmanagement/issues).

### Contributing code

- Check out open issues on [our Kanban board](https://github.com/orgs/galasa-dev/projects/3), especially ones with the label `good first issue`.
- Other common labels include `webui`, `cli` or `REST API`. Typically, stories without one of these three tags will imply it's a change needing to be made to this repository.

### Abide by the contributions legal guidance
To ship, all developer contributions must abide by the legal guidance detailed in the [Developer Certificate of Origin](./CONTRIBUTIONS.md)

### Documentation

- Fix typos, improve examples, or enhance explanations.

## How to make a contribution to this Repository

### Sign your commits

Make sure you are able to sign commits with your personal GPG key. See https://git-scm.com/book/ms/v2/Git-Tools-Signing-Your-Work

Whenever you commit, please sign commits with `-s -S` flags to sign the commit.
This allows us to prove who made each change to the codebase.

Each PR build has "Developer Certificate of Origin" [DCO](./CONTRIBUTIONS.md) checking turned on, so nothing will get
delivered without signed commits.

If you forgot to sign one or all of your commits, you can squash your PR changes, sign them, then force-push your branch.

### Set up a fork of a repository

1. On GitHub, navigate to the repository.
1. In the top-right corner of the page, click Fork.
1. Select an owner for the forked repository from the dropdown menu under "Owner".
1. The fork will be named the same as the upstream repository as default. Optionally, to further distinguish your fork, type a name in the "Repository name" field.
1. Optionally, type a description for your fork in the "Description" field.
1. Optionally, select "Copy the `main` branch only".
1. Click "Create fork".

### Clone the forked repository and make changes
1. Clone your forked repository to your machine:
```
git clone https://github.com/YOUR-USERNAME/webui.git
```
2. Make your changes and ensure they build locally with the `/build-locally.sh` script and that the unit tests pass.

### Contribute code back to the project
1. Add the original repository, `upstream`, as a remote, and ensure you cannot push to it:
```
# replace <upstream git repo> with the upstream repo URL
# example:
# https://github.com/galasa-dev/webui.git
# git@github.com/galasa-dev/webui.git

git remote add upstream <upstream git repo>
git remote set-url --push upstream no_push
```
2. Verify this step by listing your configured remote repositories:
```
git remote -v
```
3. Create a new branch for your contribution:
```
git checkout -b issue-number/contribution-description
```
4. Make your changes and commit them, ensuring to DCO and GPG sign your commits:
Please use https://www.conventionalcommits.org/en/v1.0.0/ as a guide for making commits, in the. format `type(scope)!: description` (Scope and ! for breaking changes are optional), where types include:
- feat: A new feature.
- fix: A bug fix.
- docs: Documentation changes.
- style: Formatting, missing semicolons, etc..
- refactor: Code change that neither fixes a bug nor adds a feature.
- test: Adding missing tests or correcting existing tests.
- build: Changes that affect the build system or external dependencies.
- ci: Changes to CI configuration files and scripts.

For example, `feat(auth): add JWT token refresh endpoint`,
```
git commit -s -S -m "Add a meaningful commit message"
```
5. Push your changes to your fork:
```
git push origin issue-number/contribution-description
```
6. Open a pull request from your forked repository branch to the main branch of the 'webui repository', and explain your changes. Refer to any stories which are relevent and explain why the change was made, what the change is, and anything else which reviewers would find helpful to understand the context of the change.