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

feat: [AH-3049] Open source contributions documentation #184

Merged
merged 13 commits into from
Apr 11, 2024

Conversation

VebjornG
Copy link
Contributor

@VebjornG VebjornG commented Apr 10, 2024

Since InDSL is generally available it should have documentation covering open source contributions. This PR aims to provide that.
Ticket

Copy link

codecov bot commented Apr 10, 2024

Codecov Report

Merging #184 (b499831) into main (dba13c9) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #184   +/-   ##
=======================================
  Coverage   91.37%   91.37%           
=======================================
  Files         105      105           
  Lines        3837     3837           
  Branches      832      832           
=======================================
  Hits         3506     3506           
  Misses        206      206           
  Partials      125      125           

Copy link

github-actions bot commented Apr 10, 2024

Unit Test Results

    21 files  ±0      21 suites  ±0   54m 19s ⏱️ + 3m 24s
 1 103 tests ±0   1 103 ✅ ±0   0 💤 ±0  0 ❌ ±0 
15 651 runs  ±0  15 640 ✅ ±0  11 💤 ±0  0 ❌ ±0 

Results for commit b499831. ± Comparison against base commit dba13c9.

♻️ This comment has been updated with latest results.

@VebjornG VebjornG requested a review from neringaalt April 10, 2024 10:21
Make sure that they pass.

5. **Make a pull request**: Once you are satisfied with your changes and all of the tests pass, make a pull request to
the main repository using the conventional commit message format.
Copy link
Contributor

Choose a reason for hiding this comment

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

add a link to indsl

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That link is at the top of the "Contributing" section though

Copy link
Contributor

Choose a reason for hiding this comment

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

It can be confusing to know what we mean by "main repository"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then i think it's better to change the wording here

@neringaalt
Copy link
Contributor

@VebjornG could you fix all the places in the documentation where it says that repository should be cloned? We need to make sure that it should be done by forking repo for open source contributions, but Cognite people could clone it directly. Could you figure out how to phrase those sentences? Maybe with links for the open source contributions?

@VebjornG
Copy link
Contributor Author

@VebjornG could you fix all the places in the documentation where it says that repository should be cloned? We need to make sure that it should be done by forking repo for open source contributions, but Cognite people could clone it directly. Could you figure out how to phrase those sentences? Maybe with links for the open source contributions?

Made a suggestion in the latest commit 👍🏻

@VebjornG VebjornG requested a review from neringaalt April 10, 2024 11:33
@VebjornG VebjornG changed the title feat: open source contributions documentation [AH-3049] feat: open source contributions documentation Apr 11, 2024
@VebjornG VebjornG marked this pull request as ready for review April 11, 2024 11:25
@VebjornG VebjornG requested review from a team and MortGron April 11, 2024 11:25
@VebjornG VebjornG changed the title [AH-3049] feat: open source contributions documentation feat: [AH-3049] Open source contributions documentation Apr 11, 2024
@VebjornG VebjornG requested a review from neringaalt April 11, 2024 11:27
@VebjornG VebjornG merged commit 629ff47 into main Apr 11, 2024
31 of 32 checks passed
@VebjornG VebjornG deleted the vebjorn/open-source-contr branch April 11, 2024 12:36
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

Successfully merging this pull request may close these issues.

2 participants