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

Create a basic CONTRIBUTING.md #3333

Merged
merged 3 commits into from
Nov 2, 2023
Merged

Conversation

FliegendeWurst
Copy link
Member

This PR proposes a CONTRIBUTING.md giving some basic guidance on contributing to KeY.
It is based on the wiki page.
I decided to not mention the outdated gitlab.com mirrors (related: KeYProject/key-docs#15).

Resolves #1593 (see that issue for more discussion).

@FliegendeWurst FliegendeWurst added the Documentation Improvements or additions to documentation label Oct 30, 2023
Co-Authored-By: Mattias Ulbrich <[email protected]>
@codecov
Copy link

codecov bot commented Oct 30, 2023

Codecov Report

Merging #3333 (141204b) into main (1b1ddf1) will decrease coverage by 0.02%.
Report is 7 commits behind head on main.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #3333      +/-   ##
============================================
- Coverage     37.84%   37.82%   -0.02%     
+ Complexity    16883    16875       -8     
============================================
  Files          2052     2052              
  Lines        125439   125439              
  Branches      21215    21215              
============================================
- Hits          47469    47444      -25     
- Misses        72117    72141      +24     
- Partials       5853     5854       +1     

see 42 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@wadoon wadoon left a comment

Choose a reason for hiding this comment

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

Thank you for the effort.

Suggestions:

In general, a link to PRs should be given
also a link to the code guideline
The license should be made clearer, either to "GPL2-or-later" or "GPL2-only".
You may want to look in the new readme (used on [helmholtz.software] for Key), which states

Feel free to submit Pull Requests via Github. Pull Requests are assessed using an automatically tests, formatting and static source checkers. More guideline and documentation for the KeY development can be found under key-docs.

@FliegendeWurst FliegendeWurst requested a review from wadoon November 2, 2023 09:59
@wadoon wadoon enabled auto-merge November 2, 2023 12:06
@wadoon wadoon added this pull request to the merge queue Nov 2, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Nov 2, 2023
@unp1 unp1 added this pull request to the merge queue Nov 2, 2023
Merged via the queue into KeYProject:main with commit ff3216d Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Finish the CONTRIBUTING.md
3 participants