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

Add forking guidelines #324

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

dffdff2423
Copy link
Contributor

Adds a page outlining forking guidelines and best practices. A large amount of content in this is derived from https://gist.github.com/moonheart08/2d3945faf3cf691437e1e1fa0e922420. I have permission from the author to use their work in this PR. It also incorporates some of my own advice gained from working on Cosmatic Drift.

src/en/general-development/tips/forking.md Outdated Show resolved Hide resolved
src/en/general-development/tips/forking.md Outdated Show resolved Hide resolved
src/en/general-development/tips/forking.md Outdated Show resolved Hide resolved
@Jezithyr
Copy link
Contributor

Jezithyr commented Oct 22, 2024

This looks great so far! But it's missing a section on licensing and attribution. We should at the very least give people a basic idea of what copyright is/does, since not everyone is familiar with it and there are a ton of common misconceptions that can get you into trouble.
I'll write something up and run it by a couple of my industry connections to make sure that it's accurate to how copyright works. Licensing stuff shouldn't be a problem for most forks since they'll likely just going to keep the MIT license but it's still a good idea to make sure people are aware of misconceptions and common pitfalls.

Actually, I might just make a separate doc on copyright/licensing and then just include a brief summary in the forking guidelines. Great work on this :)

- If you do not want an upstream feature, now is the time to revert the change using `git revert`

Note that any contributors to your fork will need to press the github fork button on your repository instead of your upstream's.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a short section here summarizing the basics of copyright/licensing to help prevent people from falling into common pitfalls. I'll write something up this week unless you'd like to write something up and I can look it over :)
Once we've got that, this will be good to merge!

Copy link
Contributor Author

@dffdff2423 dffdff2423 Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually had some something small about the AGPL (most forks are not using it correctly, they are incorrectly relicensing wizden code to the AGPL when merging upstream), but opted not to include it because I did not want to start shit due to how much of a hot topic that is in ss14. We could link https://choosealicense.com/ which is written by github and I assume vetted by their lawers. I think that this document should take as much of a neutral perspective in terms of which license to choose because that is a highly personal choice.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think one of the main issues with the above site is it encourages using the GPL over the AGPL for a copyleft license which is sound advice for most projects, but will probably not do what they intend for a ss14 fork.

@Jezithyr Jezithyr added Changes Needed This Design/PR needs some changes before it can be merged Policy/Organizational Relevant to documentation of Wizden Policy or Organizational information Guides/Onboarding Related to guide/tutorial documentation and/or onboarding/developer setup labels Oct 22, 2024
@Jezithyr Jezithyr self-assigned this Oct 22, 2024
@dffdff2423
Copy link
Contributor Author

dffdff2423 commented Oct 22, 2024

I actually ended up writing a short copyright gide. Let me know if you want me to change anything. My goal was to take as neutral of a stance as possible while giving a basic explanation of all of the licenses that I am aware of ss14 forks using. If people don't understand the basics of software copyright I think they should be referred elsewhere given it is such a complex topic and most (all?) of the people who work on ss14 are not experts in it and such should not be writing a guide on copyright.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes Needed This Design/PR needs some changes before it can be merged English Guides/Onboarding Related to guide/tutorial documentation and/or onboarding/developer setup Policy/Organizational Relevant to documentation of Wizden Policy or Organizational information
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants