From 36784eb94a3e3e9708d5a319646dfc23508a3949 Mon Sep 17 00:00:00 2001 From: Najmul Hasan <123287444+najmulhasan-code@users.noreply.github.com> Date: Tue, 5 Nov 2024 22:02:07 -0500 Subject: [PATCH 1/3] Add CONTRIBUTING.md with detailed contribution instructions and update README.md with reference link. --- CONTRIBUTING.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 40 +------------------------- 2 files changed, 76 insertions(+), 39 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f3d4384 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# Contributing + +We welcome contributions to the supercontrast! To get started, please follow these steps: + +### 1. Fork the Repository + +First, fork the repository on GitHub to create your own copy. Then, clone your fork to your local machine: + +```bash +git clone https://github.com/YOUR_USERNAME/supercontrast.git +``` + +### 2. Install the Package +Navigate to the project directory and install the package in development mode: + +``` +cd supercontrast +pip install -e .[dev] + +``` + +### 3. Make Your Changes +Create a new branch to make your changes. Use a descriptive name for your branch, such as `feature/add-new-feature` or `bugfix/fix-issue-123` + +``` +git checkout -b feature/add-new-feature + +``` + +### 4. Run Linting +To maintain code quality and consistency, run linting tools: + +``` +black . +isort . +``` + +### 5. Commit Your Changes +After making and verifying changes, commit them with a clear and concise message: + +``` +git add . +git commit -m "Add new feature: description of feature" +``` + +### 6. Run Tests +Run the test suite to ensure everything is working correctly: +``` +pytest +``` + +### 7. Push to Your Fork +Push your changes to your fork on GitHub: +``` +git push origin feature/add-new-feature +``` + +### 8. Submit a Pull Request (PR) +Go to the original repository on GitHub and submit a pull request from your branch. Provide a detailed description of your changes, including the purpose and any relevant details. You can use the following command to create the PR via GitHub CLI: + +``` +gh pr create --title "Add new feature: description" --body "Detailed description of the changes." + +``` +### Issue Reporting + +If you find a bug or would like to request a feature, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the problem if applicable. + +### Documentation Improvements + +We welcome contributions to our documentation. If you find outdated information, unclear explanations, or think a section could use more examples, feel free to submit a pull request. + +### Community Guidelines + +When contributing to this project, please adhere to our code of conduct. Be respectful of others' opinions and contributions, and keep the discussions focused on making the project better. diff --git a/README.md b/README.md index 267b966..561a372 100644 --- a/README.md +++ b/README.md @@ -82,42 +82,4 @@ For more examples of how to use `supercontrast`, refer to [examples.py](examples ## Contributing -We welcome contributions to the project! To contribute, please follow these steps: - -### 1. Clone the repo - -```bash -git clone https://github.com/supercontrast/supercontrast.git -``` - -### 2. Install package in editable mode - -```bash -pip install -e . -``` - -### 3. Run linting - -```bash -black . -isort . -``` - -### 4. Run tests - -```bash -pytest -k -``` - -### 5. Submit a PR - -Submit a PR to the main branch! We will review and merge your PR. - - - - - - - - - +Contributions to supercontrast are welcome. Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed guidelines. \ No newline at end of file From 9141ad6baed36c43e750bca002bccc8db5b62edf Mon Sep 17 00:00:00 2001 From: Najmul Hasan <123287444+najmulhasan-code@users.noreply.github.com> Date: Tue, 5 Nov 2024 22:06:52 -0500 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3d4384..b15b052 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -We welcome contributions to the supercontrast! To get started, please follow these steps: +We welcome contributions to the Supercontrast project!To get started, please follow these steps: ### 1. Fork the Repository @@ -16,7 +16,6 @@ Navigate to the project directory and install the package in development mode: ``` cd supercontrast pip install -e .[dev] - ``` ### 3. Make Your Changes @@ -24,7 +23,6 @@ Create a new branch to make your changes. Use a descriptive name for your branch ``` git checkout -b feature/add-new-feature - ``` ### 4. Run Linting @@ -60,7 +58,6 @@ Go to the original repository on GitHub and submit a pull request from your bran ``` gh pr create --title "Add new feature: description" --body "Detailed description of the changes." - ``` ### Issue Reporting From 2c1902523634e320a9ecf330d01983815d3f0ad1 Mon Sep 17 00:00:00 2001 From: Najmul Hasan <123287444+najmulhasan-code@users.noreply.github.com> Date: Tue, 5 Nov 2024 22:07:09 -0500 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b15b052..c9a8778 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -We welcome contributions to the Supercontrast project!To get started, please follow these steps: +We welcome contributions to the Supercontrast project! To get started, please follow these steps: ### 1. Fork the Repository