mirror of
				https://github.com/ComputerScienceHouse/proxstar.git
				synced 2025-03-09 15:40:09 +00:00 
			
		
		
		
	Add pylint_quotes to pylintrc and update readme
This commit is contained in:
		
							parent
							
								
									d6eaeaf33e
								
							
						
					
					
						commit
						b85ad88df4
					
				
					 3 changed files with 6 additions and 3 deletions
				
			
		| 
						 | 
				
			
			@ -1,6 +1,7 @@
 | 
			
		|||
[MASTER]
 | 
			
		||||
ignore = ,input
 | 
			
		||||
persistent = yes
 | 
			
		||||
load-plugins = pylint_quotes
 | 
			
		||||
 | 
			
		||||
[MESSAGES CONTROL]
 | 
			
		||||
disable =
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -5,4 +5,4 @@ python:
 | 
			
		|||
install:
 | 
			
		||||
  - "pip install -r requirements.txt"
 | 
			
		||||
script:
 | 
			
		||||
  - "pylint --load-plugins pylint_quotes proxstar"
 | 
			
		||||
  - "pylint proxstar"
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -16,9 +16,11 @@ It is available to house members at [proxstar.csh.rit.edu](https://proxstar.csh.
 | 
			
		|||
## Contributing
 | 
			
		||||
 | 
			
		||||
1. [Fork](https://help.github.com/en/articles/fork-a-repo) this repository
 | 
			
		||||
    - Optionally create a new [git branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) if your change is more than a small tweak (`git checkout -b BRANCH-NAME-HERE`)
 | 
			
		||||
  - Optionally create a new [git branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) if your change is more than a small tweak (`git checkout -b BRANCH-NAME-HERE`)
 | 
			
		||||
3. Make your changes locally, commit, and push to your fork
 | 
			
		||||
    - If you want to test locally, you should copy `config.py` to `config_local.py`, and talk to an RTP about filling in secrets.
 | 
			
		||||
  - If you want to test locally, you should copy `config.py` to `config_local.py`, and talk to an RTP about filling in secrets.
 | 
			
		||||
  - Lint your local changes with `pylint proxstar`
 | 
			
		||||
    - You'll need dependencies installed locally to do this. You should do that in a [venv](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) of some sort to keep your system clean. All the dependencies are listed in [requirements.txt](./requirements.txt), so you can install everything with `pip install -r requirements.txt`. You'll need python 3.6 at minimum, though things should work up to python 3.8.
 | 
			
		||||
4. Create a [Pull Request](https://help.github.com/en/articles/about-pull-requests) on this repo for our Webmasters to review
 | 
			
		||||
 | 
			
		||||
## Questions/Concerns
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue