forked from ISPsystem/isp-maintenance
		
	Update: name project, deps, docs
This commit is contained in:
		
							parent
							
								
									1cbaff3214
								
							
						
					
					
						commit
						6e882e82c6
					
				
							
								
								
									
										75
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										75
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,75 @@ | |||||||
|  | # Contributing to isp-maintenance | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Getting started | ||||||
|  | 
 | ||||||
|  | To get started, fork the isp-maintenance `isp-maintenance` git repository on Gitea and clone it: | ||||||
|  | 
 | ||||||
|  |     $ git clone git@git.isptech.ru:<user>/isp-maintenance.git | ||||||
|  | 
 | ||||||
|  | To keep your forked repository up to date, setup the `upstream` remote to pull in new changes: | ||||||
|  | 
 | ||||||
|  |     $ git remote add upstream https://git.isptech.ru/ISPsystem/isp-maintenance.git | ||||||
|  |     $ git pull --rebase upstream main | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Creating a new feature, fix, etc | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | Using the Gitea web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes. | ||||||
|  | 
 | ||||||
|  | Using the `main` branch of your fork for contributing is also strongly discouraged. | ||||||
|  | It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once. | ||||||
|  | To create a new branch: | ||||||
|  | 
 | ||||||
|  |     $ git checkout main -b <a-descriptive-name> | ||||||
|  | 
 | ||||||
|  | - Stick to PEP and use a linter. We use flake8 (default config) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Starting a pull request | ||||||
|  | 
 | ||||||
|  | Once you have successfully built the package, you can [create a pull request](https://docs.gitea.com/usage/pull-request). | ||||||
|  | Pull requests are also known as PRs. | ||||||
|  | 
 | ||||||
|  | Most pull requests should only contain a single feature or fix. | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | Before a pull request, update the `main` branch and rebase to your branch. | ||||||
|  | [rebase docs](https://git-scm.com/book/ru/v2/Ветвление-в-Git-Перебазирование). | ||||||
|  | 
 | ||||||
|  |     $ git checkout main  | ||||||
|  |     $ git pull --rebase upstream main | ||||||
|  |     $ git checkout <your-branch-name> | ||||||
|  |     $ git rebase main | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | #### Review | ||||||
|  | 
 | ||||||
|  | It's possible (and common) that a pull request will contain mistakes or reviewers will ask for additional tweaks. | ||||||
|  | Reviewers will comment on your pull request and point out which changes are needed before the pull request can be merged. | ||||||
|  | 
 | ||||||
|  | Most PRs will have a single commit, as seen so if you need to make changes to the commit and already have a pull request open, you can use the following commands: | ||||||
|  | 
 | ||||||
|  |     $ git add <file> | ||||||
|  |     $ git commit --amend | ||||||
|  |     $ git push -f | ||||||
|  | 
 | ||||||
|  | A more powerful way of modifying commits than using `git commit --amend` is with [git-rebase](https://git-scm.com/docs/git-rebase#_interactive_mode), which allows you to join, reorder, change description of past commits and more. | ||||||
|  | 
 | ||||||
|  | Alternatively, if there are issues with your git history, you can make another branch and push it to the existing PR: | ||||||
|  | 
 | ||||||
|  |     $ git checkout main -b <attempt2> | ||||||
|  |     $ # do changes anew | ||||||
|  |     $ git push -f <fork> <attempt2>:<branch-of-pr> | ||||||
|  | 
 | ||||||
|  | #### Closing the pull request | ||||||
|  | 
 | ||||||
|  | Once you have applied all requested changes, the reviewers will merge your request. | ||||||
|  | 
 | ||||||
|  | If the pull request becomes inactive for some days, the reviewers may or may not warn you when they are about to close it. | ||||||
|  | If it stays inactive further, it will be closed. | ||||||
|  | 
 | ||||||
|  | Please abstain from temporarily closing a pull request while revising the templates. | ||||||
|  | Instead, leave a comment on the PR describing what still needs work,  add "[[WIP](https://docs.gitea.com/usage/automatically-linked-references)]" to the PR title.  | ||||||
|  | Only close your pull request if you're sure you don't want your changes to be included. | ||||||
| @ -1,3 +1,8 @@ | |||||||
| # isp_maintenance | # isp-maintenance | ||||||
| 
 | 
 | ||||||
| Maintenance application for quick access, check and resolve issues VM/DCImanager 6 generation | Maintenance application for quick access, check and resolve issues VM/DCImanager 6 generation | ||||||
|  | 
 | ||||||
|  | ### In progress | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### See [CONTRIBUTING.md](CONTRIBUTING.md) for a general overview of how to contribute  | ||||||
							
								
								
									
										4
									
								
								poetry.lock
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										4
									
								
								poetry.lock
									
									
									
										generated
									
									
									
								
							| @ -175,12 +175,12 @@ files = [ | |||||||
| 
 | 
 | ||||||
| [[package]] | [[package]] | ||||||
| name = "peewee" | name = "peewee" | ||||||
| version = "3.17.0" | version = "3.17.1" | ||||||
| description = "a little orm" | description = "a little orm" | ||||||
| optional = false | optional = false | ||||||
| python-versions = "*" | python-versions = "*" | ||||||
| files = [ | files = [ | ||||||
|     {file = "peewee-3.17.0.tar.gz", hash = "sha256:3a56967f28a43ca7a4287f4803752aeeb1a57a08dee2e839b99868181dfb5df8"}, |     {file = "peewee-3.17.1.tar.gz", hash = "sha256:e009ac4227c4fdc0058a56e822ad5987684f0a1fbb20fed577200785102581c3"}, | ||||||
| ] | ] | ||||||
| 
 | 
 | ||||||
| [[package]] | [[package]] | ||||||
|  | |||||||
| @ -1,5 +1,5 @@ | |||||||
| [tool.poetry] | [tool.poetry] | ||||||
| name = "isp_maintenance" | name = "isp-maintenance" | ||||||
| version = "0.1.0" | version = "0.1.0" | ||||||
| description = "Maintenance service for ISPsystem platforms" | description = "Maintenance service for ISPsystem platforms" | ||||||
| authors = ["MOIS3Y <s.zhukovskii@ispsystem.com>", "Failak3 <v.shmidt@ispsystem.com>", "a.garaev <a.garaev@ispsystem.com>", "Ann_M <a.moskovkina@ispsystem.com>"] | authors = ["MOIS3Y <s.zhukovskii@ispsystem.com>", "Failak3 <v.shmidt@ispsystem.com>", "a.garaev <a.garaev@ispsystem.com>", "Ann_M <a.moskovkina@ispsystem.com>"] | ||||||
|  | |||||||
| @ -101,8 +101,8 @@ colorama==0.4.6 ; python_version >= "3.11" and python_version < "4.0" and platfo | |||||||
| idna==3.6 ; python_version >= "3.11" and python_version < "4.0" \ | idna==3.6 ; python_version >= "3.11" and python_version < "4.0" \ | ||||||
|     --hash=sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca \ |     --hash=sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca \ | ||||||
|     --hash=sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f |     --hash=sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f | ||||||
| peewee==3.17.0 ; python_version >= "3.11" and python_version < "4.0" \ | peewee==3.17.1 ; python_version >= "3.11" and python_version < "4.0" \ | ||||||
|     --hash=sha256:3a56967f28a43ca7a4287f4803752aeeb1a57a08dee2e839b99868181dfb5df8 |     --hash=sha256:e009ac4227c4fdc0058a56e822ad5987684f0a1fbb20fed577200785102581c3 | ||||||
| requests==2.31.0 ; python_version >= "3.11" and python_version < "4.0" \ | requests==2.31.0 ; python_version >= "3.11" and python_version < "4.0" \ | ||||||
|     --hash=sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f \ |     --hash=sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f \ | ||||||
|     --hash=sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1 |     --hash=sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user