dolphin-platform icon indicating copy to clipboard operation
dolphin-platform copied to clipboard

Add content of LICENSE and CONTRIBUTING.md files to documentation

Open hendrikebbers opened this issue 7 years ago • 3 comments

🆕🐥:dog: First Timers Only

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

:space_invader: Description of the issue

The LICENSE and CONTRIBUTING.md files are part of the Dolphin Platform repository but currently they are not in the asciidoc based documentation. The current text of this files should be added as additional chapters to the end of the documentation.

📋 Step by Step

  • 🙋 Claim this issue: Comment below.
  • 🔄 replace the up for grabs label with in progress.
  • :fork_and_knife: fork the repository in github by simply clicking the 'fork' button.
  • :arrow_heading_down: check out the forked repository
  • :twisted_rightwards_arrows: create a feature branch for the issue. We do not have any naming definition for branches.
  • 💾 Commit your changes.
  • 🔀 Start a Pull Request.
  • 🏁 Done 👍 Ask in comments for a review :)
  • 🔬 If the reviewer find some missing peaces or a problem he will start a discussion with you and describe the next steps how the problem can be solved.
  • :boom: you did it! We will merge the fix in the master of the Dolphin Platform project.
  • :bouquet: Thanks, thanks, thanks for being part as an open source contributor for Dolphin Platform

🤔❓ Questions

You can join our community chat at Slack

hendrikebbers avatar Oct 16 '17 20:10 hendrikebbers

I don't understand very well, what I should do in this issue. For this files LICENSE and CONTRIBUTING.md, I should pass to asciidoc format with the same text?

cristh18 avatar Oct 16 '17 22:10 cristh18

Yes. And it should be part in the generated documentation as separate chapters at the end

hendrikebbers avatar Oct 16 '17 22:10 hendrikebbers

can i work on this issue

dhrubo55 avatar Oct 12 '19 07:10 dhrubo55