Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abstract: Code Ethique #799

Closed
Kreyren opened this issue Jan 10, 2019 · 4 comments
Closed

Abstract: Code Ethique #799

Kreyren opened this issue Jan 10, 2019 · 4 comments

Comments

@Kreyren
Copy link
Contributor

Kreyren commented Jan 10, 2019

Recommends making a default template/example installer for contributors to follow with something like Code Of Conduct/Code Ethique.

Alike the way commit messages should be written, what to avoid in writing the installers, etc..

Comments in installers

Also recommend including comments in scripts that are in testing meaning to include info which is relevant in making the installer in platinum (non-testing).

alike, 'This is not working, because winebug #1234, Needs testing, can be improved`, etc..

I believe that it would help to relay informations required to finish the installer.

Making templates

Also recommends making templates for apps that use winesteam, steam (to proton), lutris scripts, etc.. so that contributors could only change variables and remove functions if needed.

Also some open documentation which can be easily changed by contributors should be mandatory to prevent possible issues (https://github.com/PhoenicisOrg/phoenicis/issues/1748)

Expected

Effective way to make the installers the way it's expected by the upstream and to regulate contributors to prevent unnecesary 'hacky'/non-standart scripts -> easier maintainance.

@plata
Copy link
Collaborator

plata commented Jan 10, 2019

@Kreyren
Copy link
Contributor Author

Kreyren commented Jan 10, 2019

Based on #797 (comment) recommends adopting Wine naming of commits alike

<category>/<application> : <short summary>

<description of changes>

If there are more changes in a bug the issue looks very unsane alike:
image

@qparis qparis closed this as completed Jan 12, 2019
@plata
Copy link
Collaborator

plata commented Jan 12, 2019

@Kreyren I agree that this makes sense. Please provide a PR for README.md and we can discuss the details there.

Kreyren pushed a commit to Kreyrenicis/compatibilators that referenced this issue Jan 13, 2019
Relevant : PhoenicisOrg#799

Created a concept of new documentation for README.md and CONTRIBUTION.md
My abstract is to make `CONTRIBUTION.md` file with full instructions
about contribution and summary of it in README.md with summary and
introduction to a repository
Added new file with contribution that should be used as full
documentation for contributors, will also add images to make reading
more effective.
Looking for feedback
Signed-off-by: Jacob Hrbek <werifgx@gmail.com>
Kreyren pushed a commit to Kreyrenicis/compatibilators that referenced this issue Jan 13, 2019
Relevant : PhoenicisOrg#799

Created a concept of new documentation for README.md and CONTRIBUTION.md
My abstract is to make `CONTRIBUTION.md` file with full instructions
about contribution and summary of it in README.md with summary and
introduction to a repository
Added new file with contribution that should be used as full
documentation for contributors, will also add images to make reading
more effective.
Looking for feedback
Signed-off-by: Jacob Hrbek <werifgx@gmail.com>
Kreyren pushed a commit to Kreyrenicis/compatibilators that referenced this issue Jan 13, 2019
Relevant : PhoenicisOrg#799

Created a concept of new documentation for README.md and CONTRIBUTION.md
My abstract is to make CONTRIBUTION.md file with full instructions
about contribution and summary of it in README.md with summary and
introduction to a repository
Added new file with contribution that should be used as full
documentation for contributors, will also add images to make reading
more effective.

Looking for feedback
Kreyren pushed a commit to Kreyrenicis/compatibilators that referenced this issue Jan 13, 2019
Relevant : PhoenicisOrg#799

Created a concept of new documentation for README.md and CONTRIBUTION.md
My abstract is to make CONTRIBUTION.md file with full instructions
about contribution and summary of it in README.md with summary and
introduction to a repository
Added new file with contribution that should be used as full
documentation for contributors, will also add images to make reading
more effective.

Looking for feedback
@Kreyren
Copy link
Contributor Author

Kreyren commented Jan 14, 2019

@plata Created #815

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants