Contributions motivated guidelines - Revision history

Nmingott at 22:36, 6 May 2025

2025-05-06T22:36:10Z

← Older revision		Revision as of 22:36, 6 May 2025
Line 8:		Line 8:
	** I will place the recipe according to my judgement where i guess it will be better for future readers		** I will place the recipe according to my judgement where i guess it will be better for future readers
	** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.		** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.
	** if you need to define '''variables''' and your code can be run in the '''Workspace''' <u>use workspace global variables</u>. This is important to let the user run one line of code at a time and explore intermediate Object results.		** if you need to define '''variables''' and your code can be run as a code block in the '''Workspace''' <u>use workspace global variables</u>, avoid block variables. This is important to let the user run one line of code at a time and explore intermediate Object results.
	* Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.		* Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.
	* '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.		* '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.

Nmingott: about variables

2025-05-06T22:30:13Z

about variables

← Older revision		Revision as of 22:30, 6 May 2025
Line 8:		Line 8:
	** I will place the recipe according to my judgement where i guess it will be better for future readers		** I will place the recipe according to my judgement where i guess it will be better for future readers
	** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.		** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.
			** if you need to define '''variables''' and your code can be run in the '''Workspace''' <u>use workspace global variables</u>. This is important to let the user run one line of code at a time and explore intermediate Object results.
	* Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.		* Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.
	* '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.		* '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.

Nmingott at 22:18, 6 May 2025

2025-05-06T22:18:18Z

← Older revision		Revision as of 22:18, 6 May 2025
Line 2:		Line 2:
	* This Wiki is an '''authored wiki''', by that i mean that while I am willing to accept external suggestions, typos fix, bugs fix, and even full recipes from other people I will retain the final word on what gets in and where the things go placed. I have no much time for debate. You will have to trust my judgement. My first objective is to make this opera useful, in primis to other languages developers who want to get something done in Smalltalk.		* This Wiki is an '''authored wiki''', by that i mean that while I am willing to accept external suggestions, typos fix, bugs fix, and even full recipes from other people I will retain the final word on what gets in and where the things go placed. I have no much time for debate. You will have to trust my judgement. My first objective is to make this opera useful, in primis to other languages developers who want to get something done in Smalltalk.
	** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)		** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)
	*** You can be blessed in ~~2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself writing~~ [https://github.com/nmingotti/The-Cuis-CookBook/issues/2 here].		*** You can be blessed writing [https://github.com/nmingotti/The-Cuis-CookBook/issues/2 here] . If you are unknown to the community please introduce yourself with a few lines.
	* If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.		* If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.
	** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.		** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.

Nmingott at 21:43, 6 May 2025

2025-05-06T21:43:37Z

← Older revision		Revision as of 21:43, 6 May 2025
Line 3:		Line 3:
	** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)		** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)
	*** You can be blessed in 2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself writing [https://github.com/nmingotti/The-Cuis-CookBook/issues/2 here].		*** You can be blessed in 2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself writing [https://github.com/nmingotti/The-Cuis-CookBook/issues/2 here].
	*** If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.		* If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.
	**** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.		** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.
	*** You can '''insert your own recipe''' but '''you need to sign them with your real name''' and your Cuis or Squeak '''short id''', you have one if you ever made contributions. You do that at the end of the recipe.		* You can '''insert your own recipe''' but '''you need to sign them with your real name''' and your Cuis or Squeak '''short id''', you have one if you ever made contributions. You do that at the end of the recipe.
	**** I will place the recipe according to my judgement where i guess it will be better for future readers		** I will place the recipe according to my judgement where i guess it will be better for future readers
	**** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.		** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.
	~~**~~ Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.		* Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.
	~~***~~ '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.		* '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.
	*** If you add code you also write in which Image you tested it, if not obvious or relevant write also the VM version.		* If you add '''code''' you also write in which Image you tested it, if not obvious or relevant write also the VM version.
	*** For the moment <u>please don't mix</u> '''Squeak''', '''Cuis''', '''Pharo''' ... this wiki is focused in '''Cuis'''. I use also Squeak at times and i wish to have the same thing for it but i have not enough energy to start both together. When the structure will be more or less complete in Cuis we can try to cover another Smalltalk brother.		* For the moment <u>please don't mix</u> '''Squeak''', '''Cuis''', '''Pharo''' ... this wiki is focused in '''Cuis'''. I use also Squeak at times and i wish to have the same thing for it but i have not enough energy to start both together. When the structure will be more or less complete in Cuis we can try to cover another Smalltalk brother.
			* Please use a decent '''username''', something readable, no "234234", no "rtwaaerasdf", your Cuis or Squeak developer short name can be ok. Make people understand who wrote. Make me understand who you are quickly.

Nmingott at 21:37, 6 May 2025

2025-05-06T21:37:51Z

← Older revision		Revision as of 21:37, 6 May 2025
Line 2:		Line 2:
	* This Wiki is an '''authored wiki''', by that i mean that while I am willing to accept external suggestions, typos fix, bugs fix, and even full recipes from other people I will retain the final word on what gets in and where the things go placed. I have no much time for debate. You will have to trust my judgement. My first objective is to make this opera useful, in primis to other languages developers who want to get something done in Smalltalk.		* This Wiki is an '''authored wiki''', by that i mean that while I am willing to accept external suggestions, typos fix, bugs fix, and even full recipes from other people I will retain the final word on what gets in and where the things go placed. I have no much time for debate. You will have to trust my judgement. My first objective is to make this opera useful, in primis to other languages developers who want to get something done in Smalltalk.
	** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)		** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)
	*** You can be blessed in 2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself ~~this~~ ~~way~~ ~~'''XXXXTODOXXXX'''~~.		*** You can be blessed in 2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself writing [https://github.com/nmingotti/The-Cuis-CookBook/issues/2 here].
	*** If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.		*** If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.
	**** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.		**** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.

Nmingott: added page

2025-05-06T21:24:38Z

added page

New page

* Here collecting first thought about contributions.
* This Wiki is an '''authored wiki''', by that i mean that while I am willing to accept external suggestions, typos fix, bugs fix, and even full recipes from other people I will retain the final word on what gets in and where the things go placed. I have no much time for debate. You will have to trust my judgement. My first objective is to make this opera useful, in primis to other languages developers who want to get something done in Smalltalk.
** => You can make a user on your own but i must bless you to be part of the '''editor group''' (no spam)
*** You can be blessed in 2 ways. (1) I know your name from your contributions either to: code, documentation, answering beginners mail etc. in the Cuis or Squeak community. (2) You introduce yourself this way '''XXXXTODOXXXX'''.
*** If you are a '''native English speaker''' and you want to correct typos or my "synthetic English" you are very much welcome.
**** Still, please (1) don't rephrase if its not necessary (2) try to keep sentences short and simple (3) use as much as possible formal English instead of colloquial forms. Formal English is easier to understand in general for non natives.
*** You can '''insert your own recipe''' but '''you need to sign them with your real name''' and your Cuis or Squeak '''short id''', you have one if you ever made contributions. You do that at the end of the recipe.
**** I will place the recipe according to my judgement where i guess it will be better for future readers
**** I will avoid it as much as possible, but if necessary i will shorten your sentences and reformat your code to make it instantly understandable and reasonably compact.
**** Don't change '''pronoun''' in the same recipe/page! Think of your reader. If your '''imaginary reader''' is a she (e.g. your daughter) then use "she", otherwise use "he". '''Don't use "they"''' I find it extremely confusing. <u>Personally I use "he" because I am my imaginary reader,</u> this CookBook I what I wish I could have red when I started.
***** '''No politics here'''. I have my views, you have yours. Let's be Smalltalk friend and keep politics for the bar of the village.
*** If you add code you also write in which Image you tested it, if not obvious or relevant write also the VM version.
*** For the moment <u>please don't mix</u> '''Squeak''', '''Cuis''', '''Pharo''' ... this wiki is focused in '''Cuis'''. I use also Squeak at times and i wish to have the same thing for it but i have not enough energy to start both together. When the structure will be more or less complete in Cuis we can try to cover another Smalltalk brother.