Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit

Permalink
OSS (#1)
Browse files Browse the repository at this point in the history
* add SPDX and CONTRIBUTING.md
* add LICENSE.txt
* update README.md with copyright
* add github actions
* switch to setuptools_scm using pyproject.yaml
  • Loading branch information
mgeplf authored Jun 12, 2024
1 parent 00f2681 commit f926327
Show file tree
Hide file tree
Showing 25 changed files with 546 additions and 128 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/sdist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: sdist

on:
workflow_dispatch:
pull_request:
push:
branches:
- main
release:
types:
- published

jobs:

build_sdist:
name: Build sdist
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Build SDist
run: pipx run build --sdist

- name: Check metadata
run: pipx run twine check dist/*

- uses: actions/upload-artifact@v4
with:
name: build
path: dist

upload_sdist:
name: Upload sdist
needs: [build_sdist]
runs-on: ubuntu-latest
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
if: github.event_name == 'release' && github.event.action == 'published'

steps:
- uses: actions/download-artifact@v4
with:
name: build
path: dist

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
38 changes: 38 additions & 0 deletions .github/workflows/tox.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Tox

on:
workflow_dispatch:
pull_request:
push:
branches:
- main
release:
types:
- published

jobs:
tox_checks:

runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.9', '3.10', '3.11', '3.12']

steps:

- uses: actions/checkout@v4
with:
submodules: true

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools
pip install tox-gh-actions
- name: Run tox
run: tox
3 changes: 0 additions & 3 deletions .gitlab-ci.yml

This file was deleted.

49 changes: 0 additions & 49 deletions .pylintrc

This file was deleted.

108 changes: 108 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Contribution Guide

We would love for you to contribute to the neuroc project and help make it better than it is today.
As a contributor, here are the guidelines we would like you to follow:

- [Question or Problem?](#got-a-question)
- [Issues and Bugs](#found-a-bug)
- [Feature Requests](#missing-a-feature)
- [Submissions](#submission-guidelines)
- [Development Guidelines](#development)
- [Release Procedure](#release)

# Got a Question?

Please do not hesitate to raise an issue on [github project page][github].

# Found a Bug?

If you find a bug in the source code, you can help us by [submitting an issue](#issues)
to our [GitHub Repository][github]. Even better, you can [submit a Pull Request](#pull-requests) with a fix.

# Missing a Feature?

You can *request* a new feature by [submitting an issue](#issues) to our GitHub Repository.
If you would like to *implement* a new feature, please submit an issue with a proposal for your
work first, to be sure that we can use it.

Please consider what kind of change it is:

* For a **Major Feature**, first open an issue and outline your proposal so that it can be
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](#pull-requests).

# Submission Guidelines

## Issues

Before you submit an issue, please search the issue tracker, maybe an issue for your problem
already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce
and confirm it. In order to reproduce bugs we will need as much information as possible, and
preferably with an example.

## Pull Requests

When you wish to contribute to the code base, please consider the following guidelines:

* Make a [fork](https://guides.github.com/activities/forking/) of this repository.
* Make your changes in your fork, in a new git branch:

```shell
git checkout -b my-fix-branch master
```
* Create your patch, **including appropriate Python test cases**.
Please check the coding [conventions](#coding-conventions) for more information.
* Run the full test suite, and ensure that all tests pass.
* Commit your changes using a descriptive commit message.

```shell
git commit -a
```
* Push your branch to GitHub:

```shell
git push origin my-fix-branch
```
* In GitHub, send a Pull Request to the `master` branch of the upstream repository of the relevant component.
* If we suggest changes then:
* Make the required updates.
* Re-run the test suites to ensure tests are still passing.
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

```shell
git rebase master -i
git push -f
```

That’s it! Thank you for your contribution!

### After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from
the main (upstream) repository:

* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

```shell
git push origin --delete my-fix-branch
```
* Check out the master branch:

```shell
git checkout main -f
```
* Delete the local branch:

```shell
git branch -D my-fix-branch
```
* Update your main with the latest upstream version:

```shell
git pull --ff upstream main
```

[github]: https://github.com/BlueBrain/neuroc
Loading

0 comments on commit f926327

Please sign in to comment.