Skip to content

Commit ac92eae

Browse files
committed
add contribution checklist to README and CHANGELOG
1 parent 6b8b9f7 commit ac92eae

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
13+
### Changed
14+
15+
- The documentation endpoint `/docs` is only for the browser and uses openapiv3. The database schemes are accessed through `/api/schema`. For compatibility, if the headers require `coreapi`, the endpoint returns a frozen set of endpoint to the client. [#929](https://github.com/cortex-lab/alyx/pull/929)
16+
17+
- narrative template is now available on the base action instead of only for surgeries [#938](https://github.com/cortex-lab/alyx/pull/938)
18+
19+
20+
### Removed
21+
22+
- coreapi dependency is removed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ More complex deployments scenarios using web servers and Cloud applications are
2727
* alyx-dev is sync with the **dev** branch
2828
* Migrations files are always provided by the repository
2929

30+
Contribution checklist:
31+
- [ ] lint using ruff `ruff check .` at the root of the repository
32+
- [ ] tests pass (see below how to run tests)
33+
- [ ] migrations are provided with the commit
34+
- [ ] update version number in `./alyx/alyx/__init__.py`
35+
- [ ] update `CHANGELOG.md`
36+
37+
3038
### Running tests
3139

3240
Continuous integration is setup. But before submitting a PR or commit,the tests can run locally.

0 commit comments

Comments
 (0)