Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating contributor guidelines #585

Merged
merged 3 commits into from
May 26, 2020
Merged

Updating contributor guidelines #585

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
157386a
updating contributor guidelines #583
May 26, 2020
02dec16
not a C API here #583
May 26, 2020
c459d86
include CI status badges
May 26, 2020
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
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ additions to source code and other files under source control, shall be made
via pull requests. A pull request must always be reviewed and merged by someone
other than its author.

Before a pull request can be approved and merged into the code base, the author
must sign the "OSP Contributor License Agreement". This agreement is pending, but
will be included in this repository with guidelines once concluded.

Programming language and style
------------------------------
Expand Down Expand Up @@ -83,15 +86,15 @@ The following are *recommendations*:

Directory structure
-------------------
The source directories are organised as follows:
`libcosim` follows the [pitchfork layout](https://api.csswg.org/bikeshed/?force=1&url=https://raw.githubusercontent.com/vector-of-bool/pitchfork/develop/data/spec.bs)
and the source directories are organised as follows:

* `cmake/`: CMake scripts and other build system files.
* `data/`: Additional files included in revision control, but not explicitly code.
* `include/`: Header files that define the public API.
* `src/cpp/`: Source code for the C++ library.
* `src/c/`: Source code for the C library.
* `test/cpp/`: Test suite for the C++ library.
* `test/c/`: Test suite for the C library.
* `test/data`: Resources used by the test suites.
* `src/cosim/`: Source code with merged header placement for internal headers.
* `tests/`: Test suite for the library.
* `test/data`: Resources used by the test suite.


File names
Expand All @@ -100,8 +103,6 @@ Use the following file extensions:

* `.hpp` for C++ headers
* `.cpp` for C++ sources
* `.h` for pure C headers
* `.c` for pure C sources

Use underscores to separate words in file names (`like_this.hpp`).

Expand Down
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
libcosim - A co-simulation library for C++
==========================================

This repository contains two libraries:

* A C++ library for distributed co-simulations.
* A C library which wraps and exposes a subset of the C++ library's functions.

This repository contains the OSP C++ library for co-simulations.

See [`CONTRIBUTING.md`] for contributor guidelines and [`LICENSE`] for
terms of use.

Expand Down