Skip to content

Commit ad64e9c

Browse files
authored
Merge pull request #78 from UBC-MDS/feature/changelog.md
changelog added
2 parents 8eca15f + d2fbb54 commit ad64e9c

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

CHANGELOG.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,47 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.1.0] - milestone1
99

10-
- Upcoming features and fixes
10+
For this milestone, our team established the foundational structure and collaboration practices for the RidgeMake package.
1111

12-
## [0.1.0] - (1979-01-01)
12+
We drafted a team work contract to define expectations, accountability, and communication norms within the team. The contract is kept private as required by the course guidelines.
1313

14-
- First release
14+
We collaboratively selected the project topic and created the public project repository under the UBC-MDS GitHub organization using the minimal Python package template with the MIT license.
15+
16+
We added a project overview and planned functionality to this README, including a high-level description of the package, a list of proposed functions, and a description of how the package fits within the broader Python ecosystem.
17+
18+
We also added and customized a Code of Conduct and defined our collaboration workflow and contribution strategy in the CONTRIBUTING.md file.
19+
20+
## [0.2.0] - milestone2
21+
22+
- function ridge_r2 implementation and test by @eddeness in https://github.com/UBC-MDS/DSCI_524_group24/pull/21
23+
- Add ridge_scatter implementation and unit tests by @elsereneee in https://github.com/UBC-MDS/DSCI_524_group24/pull/22
24+
- Added revised docstring for get_reg_line() by @suryashch in https://github.com/UBC-MDS/DSCI_524_group24/pull/23
25+
- created file environment.yml by @suryashch in https://github.com/UBC-MDS/DSCI_524_group24/pull/27
26+
- add prompt for tests by @elsereneee in https://github.com/UBC-MDS/DSCI_524_group24/pull/28
27+
- created tests for get_reg_line() by @suryashch in https://github.com/UBC-MDS/DSCI_524_group24/pull/29
28+
- M2 yuexiang function/test by @lukeni777 in https://github.com/UBC-MDS/DSCI_524_group24/pull/30
29+
- Full Changelog\*\*: https://github.com/UBC-MDS/DSCI_524_group24/compare/0.0.1...0.0.2
30+
31+
## [0.3.0] - milestone3
32+
33+
- We configured a GitHub Actions continuous integration (CI) workflow to automatically run the test suite and style checks on every push and pull request to the main branch.
34+
35+
- We also configured a continuous deployment (CD) workflow that runs the same checks and publishes the package to TestPyPI on every push to the main branch. A successful deployment is indicated by the release badge on the repository README.
36+
37+
- Finally, we added more unit tests to improve test coverage and to validate the continuous integration and deployment workflows through pull requests.
38+
39+
## [0.4.0] - milestone4
40+
41+
## Milestone summary – issue review, project management, and licensing
42+
43+
- We reviewed all peer review and TA feedback and addressed at least one required fix per team member.
44+
- YUE Xiang Ni: issue 2, 3 on [issue #60](https://github.com/UBC-MDS/DSCI_524_group24/issues/60)
45+
- Suryash Chakravarty: issue 1, 2, 3 on [issue #63](https://github.com/UBC-MDS/DSCI_524_group24/issues/63)
46+
- Seungmyun Park: issue 4, 5 on [issue #60](https://github.com/UBC-MDS/DSCI_524_group24/issues/60)
47+
- Jingyi Zha: issue 2, 3 on [issue #60](https://github.com/UBC-MDS/DSCI_524_group24/issues/61)
48+
49+
- We created multiple views in the GitHub project board to track team-level and individual-level progress and performance, enabling clearer monitoring of task ownership and workflow status.
50+
51+
- Finally, we reviewed the project license and discussed its suitability by opening a dedicated GitHub issue. The issue documents our rationale for choosing the current license and serves as a formal record of the team’s licensing decision.

0 commit comments

Comments
 (0)