Skip to content

Commit

Permalink
Adding a CHANGELOG.md (#70)
Browse files Browse the repository at this point in the history
* Adding CHANGELOG.md

* Updating changelog to keepachangelog format and symantic versioning

* Updating contribution guide with changelog instructions.
  • Loading branch information
akshaysubr authored Jul 19, 2023
1 parent 9640510 commit ca84484
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitlab/merge_request_templates/Default.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This checklist encourages us to confirm any changes have been analyzed to reduce
* [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this MR.
* [ ] New or existing tests cover these changes.
* [ ] The documentation is up to date with these changes.
* [ ] CHANGELOG.md is updated with the new features or bug fixes and extra library dependencies added.

## Dependencies
Please list the new dependencies together with the NVBug link for SWIPAT approval (A SWIPAT approval is required for each new dependency).
Expand Down
33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [unreleased]

### Added

- Added a CHANGELOG.md

### Changed

### Deprecated

### Removed

### Fixed

- Fixed issue with torch-harmonics version locking

### Security

### Dependencies

## [0.1.0] - 2023-05-08

### Added

- Initial public release.

25 changes: 21 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,39 @@
## Introduction

Welcome to Project Modulus! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to Modulus. Modulus is an open-source project and, as such, its success relies on its community of contributors willing to keep improving it. Your contribution will be a valued addition to the code base; we simply ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or whether you are a first-time contributor.
Welcome to Project Modulus! We're excited you're here and want to contribute.
This documentation is intended for individuals and institutions interested in
contributing to Modulus. Modulus is an open-source project and, as such, its
success relies on its community of contributors willing to keep improving it.
Your contribution will be a valued addition to the code base; we simply ask
that you read this page and understand our contribution process, whether you
are a seasoned open-source contributor or whether you are a first-time
contributor.

### Communicate with us
We are happy to talk with you about your needs for Modulus and your ideas for contributing to the project. One way to do this is to create an issue discussing your thoughts. It might be that a very similar feature is under development or already exists, so an issue is a great starting point. If you are looking for an issue to resolve that will help, refer to the [issue](https://github.com/NVIDIA/modulus/issues) section.
We are happy to talk with you about your needs for Modulus and your ideas for
contributing to the project. One way to do this is to create an issue discussing
your thoughts. It might be that a very similar feature is under development or
already exists, so an issue is a great starting point. If you are looking for an
issue to resolve that will help, refer to the
[issue](https://github.com/NVIDIA/modulus/issues) section.


## Contribute to Modulus-Core

### Pull Requests
Developer workflow for code contributions is as follows:

1. Developers must first [fork](https://help.github.com/en/articles/fork-a-repo) the [upstream](https://github.com/NVIDIA/Modulus) Modulus repository.
1. Developers must first [fork](https://help.github.com/en/articles/fork-a-repo)
the [upstream](https://github.com/NVIDIA/Modulus) Modulus repository.

2. Git clone the forked repository and push changes to the personal fork.

3. Once the code changes are staged on the fork and ready for review, a [Pull Request](https://help.github.com/en/articles/about-pull-requests) (PR) can be [requested](https://help.github.com/en/articles/creating-a-pull-request) to merge the changes from a branch of the fork into a selected branch of upstream.
3. Once the code changes are staged on the fork and ready for review, a
[Pull Request](https://help.github.com/en/articles/about-pull-requests) (PR)
can be [requested](https://help.github.com/en/articles/creating-a-pull-request)
to merge the changes from a branch of the fork into a selected branch of upstream.
* Exercise caution when selecting the source and target branches for the PR.
* Ensure that you update the [`CHANGELOG.md`](CHANGELOG.md) to reflect your contributions.
* Creation of a PR creation kicks off CI and a code review process.
* Atleast one Modulus engineer will be assigned for the review.

Expand Down

0 comments on commit ca84484

Please sign in to comment.