Skip to content

Commit

Permalink
Addition of contributing guide (#38)
Browse files Browse the repository at this point in the history
* Added logo to README.md

* Addition of CONTRIBUTING.md

* Runs job on every PR

* Run on every PR

* Delete unneeded files
  • Loading branch information
JustCallMeRay authored Sep 22, 2024
1 parent d771929 commit 31a0d1e
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 109 deletions.
1 change: 0 additions & 1 deletion .github/workflows/ubuntu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:

env:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
Expand Down
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
TLDR: The expected, merge into main, reference issues in PRs.

## Documentation

Out of source (non-inline) documentation such as design diagrams should be added to the `docs` folder as should images for readmes or anything else that is not within the `docs` folder.

## Code
All source code should be in C++ following best practices guidelines where possible (such as avoiding `new` and `delete`).
<!-- start formatting --!> Indentation should be done with spaces not tabs and a trailing new line should be added to the end of each file (this makes the diffs cleaner).
<!-- A formatter will be added then replace with the following: -->
<!-- All code should be formatted using the included clang format file. If you disagree with the formatter please create a PR to change it. -->


## PRs

PRs should have a base branch of (and merge into) main with no merge conflicts. Please keep your branch as up to date as possible.

Your PR should include the issue number (e.g. "closes #1234"), there is no need to do so in commit messages.

## Code of Conduct
Our code of conduct is "be kind to eachother" unless otherwise stated.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
![img](https://github.com/tpecholt/imrad/actions/workflows/ubuntu.yml/badge.svg)

# ImRAD
<div align="center">
<img src="./src/icon.png" alt="logo" width="200" align="center">
</div>

ImRAD is a GUI builder for the ImGui library. It generates and parses C++ code which can be directly used in your application.

Expand Down
81 changes: 0 additions & 81 deletions doc/test.cpp

This file was deleted.

26 changes: 0 additions & 26 deletions doc/test.h

This file was deleted.

0 comments on commit 31a0d1e

Please sign in to comment.