-
Notifications
You must be signed in to change notification settings - Fork 19
/
index.md
38 lines (20 loc) · 2.75 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# How to Contribute
ML EVN is an open community. We welcome your feedback, suggestions and contributions.
The content on mlevn.org is served from the [github.com/MLEVN/mlevn.github.io](https://github.com/MLEVN/mlevn.github.io) repo with [GitHub Pages](https://guides.github.com/features/pages/) and [Jekyll](https://help.github.com/articles/about-github-pages-and-jekyll/).
<!--- *Read [about ML EVN](/about/) and [frequently asked questions](/faq/)* --->
## How to add and edit content
GitHub Pages uses [Markdown](https://guides.github.com/features/mastering-markdown/), a lightweight and easy-to-use syntax for basic styling without using HTML. Markdown files end with `.md`.
To add to or edit the content, just create or edit a file in the [github.com/MLEVN/mlevn.github.io](https://github.com/MLEVN/mlevn.github.io) repo and then [create a pull request](https://help.github.com/articles/creating-a-pull-request/).
For example, to add your company to the [*Companies*](/companies/) page, click *Edit on GitHub* at the bottom of the page, and click the <i class="fas fa-pencil-alt"></i> edit icon. You should see:
> You’re editing a file in a project you don’t have write access to. We’ve created a fork of this project for you to commit your proposed changes to. Submitting a change to this file will write it to a new branch in your fork, so you can send a pull request.
Edit the text as you would like and then click *Preview changes* to see how it looks. When you are happy with your edits, scroll down, add a helpful title and comment and click the *Propose changes* button to send the pull request.
Once we accept the pull request your changes will appear on mlevn.org.
## How to report issues
To report bugs, give feedback or suggest changes, [open a Github issue](https://github.com/MLEVN/mlevn.github.io/issues/new)
You can also browse [all open issues](https://github.com/MLEVN/mlevn.github.io/issues).
*Read more about [GitHub issues](https://guides.github.com/features/issues/)*
## How to post to the community
We use Reddit as the forum for sharing within our community. In [/r/MLEVN](https://reddit.com/r/mlevn) click [Submit a link](https://www.reddit.com/r/MLEVN/submit) (classic) or [Create post](https://new.reddit.com/r/MLEVN/submit) (new) to submit a link, media file or text.
After submitting a post you can flair it with the appropriate topic tags so that other members can easily find it in search results.
Text and comments on Reddit also support Markdown, like GitHub Pages.
Top posts to /r/MLEVN are automatically piped to our [Twitter page](https://twitter.com/ML_EVN) and [Facebook page](https://www.facebook.com/MLEVN.org/). The title is copied verbatim, so if you use a URL or @username in the title it will be hyperlinked in the post on those platforms.