mirror of
https://github.com/samsonjs/agate.git
synced 2026-03-25 09:05:50 +00:00
update CHANGELOG and CONTRIBUTING
Moved updating the changelog from the quality standards up to the workflow section so it should not be missed, since it is not really a quality standard but an action to be performed.
This commit is contained in:
parent
b5fa24cb5b
commit
bc501ebcc5
3 changed files with 12 additions and 4 deletions
12
CHANGELOG.md
12
CHANGELOG.md
|
|
@ -6,10 +6,16 @@ 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]
|
||||
Thank you to @06kellyjac for contributing to this release.
|
||||
|
||||
* Have help exit with successfully with `0` rather than `1`
|
||||
* Split out install steps to allow for more options in the future
|
||||
* Add install notes for nix/NixOS
|
||||
### Changed
|
||||
* Forbid unsafe code.
|
||||
|
||||
### Fixed
|
||||
* Updated `url` to newest version, which resolves a TODO.
|
||||
* The help exits successfully with `0` rather than `1`.
|
||||
* Split out install steps to allow for more options in the future.
|
||||
* Add install notes for nix/NixOS to the README.
|
||||
|
||||
## [2.5.2] - 2021-02-12
|
||||
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@ Follow these steps to contribute to the project:
|
|||
1. Make a fork of the [Agate repository][agate-repo].
|
||||
1. Within your fork, create a branch for your contribution. Use a meaningful name.
|
||||
1. Create your contribution, meeting all [contribution quality standards](#quality-standards).
|
||||
1. Update the changelog with any added, removed, changed, or fixed functionality. Adhere to the changelog format.
|
||||
1. [Create a pull request][create-a-pr] against the `master` branch of the repository.
|
||||
1. Once the pull request is reviewed and CI passes, it will be merged.
|
||||
|
||||
|
|
@ -64,7 +65,6 @@ Most quality and style standards are checked automatically by the CI build.
|
|||
Contributions should:
|
||||
|
||||
- Separate each **logical change** into its own commit.
|
||||
- Update the changelog with any added, removed, changed, or fixed functionality. Adhere to the changelog format.
|
||||
- Ensure the code compiles correctly, if you can also run `cargo clippy`.
|
||||
- Format code with `cargo fmt`.
|
||||
- Avoid adding `unsafe` code.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
#![forbid(unsafe_code)]
|
||||
|
||||
mod metadata;
|
||||
use metadata::{FileOptions, PresetMeta};
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue