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

Dotty internals docs update, dotty knowledge collection system integration #6786

Merged
merged 11 commits into from
Jul 5, 2019

Conversation

anatoliykmetyuk
Copy link
Contributor

This PR ports the knowledge from https://github.com/anatoliykmetyuk/dotty-cookbook to the official docs. Also, I've created https://github.com/lampepfl/dotty-knowledge where we can collect new knowledge (and also express intents with respect to e.g. modification of the knowledge base or flagging content as outdated). Also, this PR adds the following badge to this repo:

Log Knowledge

I did this to further reduce the overhead of knowledge collection so that the means to log your knowledge is highly visible and clear. However, this may create the risk of abuse by non-contributors using "Add Knowledge" feature to log user-side knowledge. I think this risk is acceptable and in line with the overall philosophy of deliberately not going for quality on the knowledge collection stage.

Comments and suggestions are welcome!

Copy link
Member

@dottybot dottybot left a comment

Choose a reason for hiding this comment

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

Hello, and thank you for opening this PR! 🎉

All contributors have signed the CLA, thank you! ❤️

Commit Messages

We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).

Please stick to these guidelines for commit messages:

  1. Separate subject from body with a blank line
  2. When fixing an issue, start your commit message with Fix #<ISSUE-NBR>:
  3. Limit the subject line to 72 characters
  4. Capitalize the subject line
  5. Do not end the subject line with a period
  6. Use the imperative mood in the subject line ("Add" instead of "Added")
  7. Wrap the body at 80 characters
  8. Use the body to explain what and why vs. how

adapted from https://chris.beams.io/posts/git-commit

Have an awesome day! ☀️

docs/docs/contributing/debugging.md Outdated Show resolved Hide resolved
docs/docs/contributing/debugging.md Show resolved Hide resolved
docs/docs/contributing/debugging.md Outdated Show resolved Hide resolved
docs/docs/contributing/scala2-vs-scala3.md Outdated Show resolved Hide resolved
docs/docs/contributing/scala2-vs-scala3.md Outdated Show resolved Hide resolved
docs/docs/contributing/scala2-vs-scala3.md Show resolved Hide resolved
docs/docs/contributing/tools/sbt.md Outdated Show resolved Hide resolved
docs/docs/contributing/procedures/vulpix.md Show resolved Hide resolved
@anatoliykmetyuk anatoliykmetyuk merged commit c10437e into scala:master Jul 5, 2019
@anatoliykmetyuk anatoliykmetyuk deleted the dotty-knowledge branch July 5, 2019 12:58
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.

3 participants