From 6618b9ad2fe05fa330d0510da42dba62df909157 Mon Sep 17 00:00:00 2001 From: Santhosh C Date: Wed, 2 Oct 2024 11:57:43 +0530 Subject: [PATCH] add contributing.md (#17) * add contributing.md * bump version and update readme * link contribution file in readme --- CHANGELOG.md | 16 +++---- CONTRIBUTING.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++ Cargo.toml | 2 +- README.md | 8 +++- 4 files changed, 130 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 1abecb3..87b535c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,19 @@ ## [0.4.1] - 2024-10-02 -### Added +### Features -- `--tag` flag to `git` command -- `--commit` flag to `git` command +- add `--tag` flag to `git` command +- add `--commit` flag to `git` command ## [0.4.0] - 2024-10-01 -### Added +### Features - `--branch` flag to `git` command ### Under the hood -- moved `git` command to `git` module +- move `git` command to `commands` module ## [0.3.2] - 2024-07-23 @@ -30,13 +30,13 @@ ## [0.3.0] - 2024-07-19 -### Added +### Features - add git remote url support ## [0.2.0] - 2024-06-16 -### Added +### Features - support for linux - `list` command to get all aliases @@ -44,7 +44,7 @@ ## [0.1.0] - 2024-05-24 -### Added +### Features - support to read links from toml file - support for mac os diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..053b8f2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,114 @@ +# Contributing to Cliq + +Thank you for your interest in contributing to Cliq! Contributions are welcome and appreciated. + +## Table of Contents + +- [How Can I Contribute?](#how-can-i-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Features](#suggesting-features) + - [Improving Documentation](#improving-documentation) + - [Contributing Code](#contributing-code) +- [Setting Up the Development Environment](#setting-up-the-development-environment) +- [Creating a Pull Request](#creating-a-pull-request) +- [License](#license) + +## How Can I Contribute? + +### Reporting Bugs + +If you find a bug, please report it by creating a new issue. Be sure to include: + +- A clear description of the bug. +- Steps to reproduce the bug. +- Expected and actual behavior. +- Any relevant screenshots or error messages. +- Your environment (OS, Rust version, etc.). + +### Suggesting Features + +We’re open to new ideas! To suggest a feature: + +- Check if the feature is already being discussed in the [issues](https://github.com/santhosh-chinnasamy/cliq/issues). +- If not, open a new issue with a clear and detailed description of the feature. +- Discuss how the feature would benefit the project and its users. + +### Improving Documentation + +Contributions to the documentation are always welcome. If you spot an area for improvement, feel free to: + +- Suggest changes by creating an issue. +- Submit a pull request with your changes. + +### Contributing Code + +#### Before You Start + +- Check the [open issues](https://github.com/santhosh-chinnasamy/cliq/issues) to see if someone else is already working on a similar fix or feature. +- If not, create a new issue or comment on an existing one to express your interest in working on it. +- Wait for approval from a maintainer before starting work on major features. + +#### Guidelines + +- Keep your code clean and readable. +- Follow Rust best practices and ensure the code compiles without errors. +- Make sure to include tests for your changes, when applicable. + +## Setting Up the Development Environment + +1. **Clone the repository:** + + ```bash + git clone https://github.com/santhosh-chinnasamy/cliq.git + cd cliq + ``` + +2. **Ensure you have Rust installed:** + + You can install Rust using [rustup](https://rustup.rs/): + + ```bash + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` + +3. **Install dependencies:** + + If the project has any external dependencies, you can install them using `cargo`: + + ```bash + cargo build + ``` + +4. **Run tests:** (WIP #16) + + To ensure everything is working as expected: + + ```bash + cargo test + ``` + +## Creating a Pull Request + +- Fork the repository. +- Create a new branch: + ```bash + git checkout -b your-feature-branch + ``` +- Make your changes, ensuring that your code is properly tested and formatted. +- Update the README.md with details of changes to the interface, if applicable. +- Update the CHANGELOG.md with notes on your changes. +- Commit your changes: + ```bash + git commit -m "Add description of the changes" + ``` +- Push the branch: + ```bash + git push origin your-feature-branch + ``` +- Open a pull request from your fork’s branch to the `main` branch of the Cliq repository. +- Describe your changes clearly in the pull request and link any related issues. +- The PR will be merged once you have the sign-off of at least one other developer/maintainer. + +## License + +By contributing to Cliq, you agree that your contributions will be licensed under the [MIT License](./LICENSE). diff --git a/Cargo.toml b/Cargo.toml index abf7381..179f50b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "cliq" description = "open frequently accessed memorable shorten urls from cli" -version = "0.4.0" +version = "0.4.1" edition = "2021" authors = ["Santhosh Chinnasamy"] readme = "README.md" diff --git a/README.md b/README.md index bc30627..96983da 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # CLIQ -open frequently accessed memorable shorten urls from cli +open frequently accessed memorable links from cli + +> Cliq is like your bookmark manager from terminal. You can add your frequently accessed urls in `cliq.toml` file and open them from terminal. It also supports opening git remote repo if `.git` exists in the current directory. ## Installation @@ -44,3 +46,7 @@ cargo install --path . - [x] Mac - [x] Linux - [ ] Windows + +## Contribution + +Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.