mirror of
				https://github.com/node-red/node-red.git
				synced 2025-03-01 10:36:34 +00:00 
			
		
		
		
	Add Sparkles Guide code contribution guidelines
This commit is contained in:
		
				
					committed by
					
						
						andrew.greene
					
				
			
			
				
	
			
			
			
						parent
						
							cf7fea53c1
						
					
				
				
					commit
					41b3e4fa11
				
			@@ -25,8 +25,7 @@ See [this](docs/sparkles-guides-contribution.md) guide, if you are looking to co
 | 
			
		||||
 | 
			
		||||
### To Code
 | 
			
		||||
 | 
			
		||||
>coming soon...
 | 
			
		||||
1. `npm run dev` # auto load code changes
 | 
			
		||||
See [this](docs/code-contribution.md) guide, if you are looking to add/remove/modify code implementing Sparkle's Guide.
 | 
			
		||||
 | 
			
		||||
## Copyright and license
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										19
									
								
								docs/code-contribution.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								docs/code-contribution.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,19 @@
 | 
			
		||||
# Code Contribution
 | 
			
		||||
 | 
			
		||||
Sparkles guide is forked from Node-red, which has a LOT of functionality in addition to the nice UI we use. As such, much code is not relevant for our purpose. 
 | 
			
		||||
 | 
			
		||||
Since this is a derivative work, using an Apache 2.0 license. We MUST add a modification copyright to any changed files not originated by us. Add `2021 Modification Copyright - Defense Unicorns` as a comment to the top of any changed file.
 | 
			
		||||
 | 
			
		||||
Finally, deleting code often has unintended consequences - you should, at a minimum, add cypress tests to confirm basic, common functionality to ensure functionality.
 | 
			
		||||
 | 
			
		||||
## Running the code
 | 
			
		||||
 | 
			
		||||
1. `npm install`
 | 
			
		||||
2. `npm run dev` # auto load code changes
 | 
			
		||||
3. open <https://127.0.0.1:1880>
 | 
			
		||||
 | 
			
		||||
## Testing code
 | 
			
		||||
 | 
			
		||||
1. `npm run dev` or `npm start`
 | 
			
		||||
2. `npm run cy:run` # Runs cypress tests
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user