CONTRIBUTING.md first version

[Dmitry Pavlov]

Hi Igniters,

Just to inform, the very first version of the Contribution step by step
guide was added to GitHub. It is one more entry point for newcomers to find
out what and how should be done to contribute:
https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite


Feel free to share with newcomers and contribute.

Sincerely,
Dmitriy Pavlov

[dmagda]

What is wrong with Ignite wiki? It seems like the right place for the doc
like this.

--
Denis

On Wed, Dec 12, 2018 at 9:21 AM Dmitriy Pavlov <[hidden email]> wrote:

> Hi Igniters,
>
> Just to inform, the very first version of the Contribution step by step
> guide was added to GitHub. It is one more entry point for newcomers to find
> out what and how should be done to contribute:
>
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
>
>
> Feel free to share with newcomers and contribute.
>
> Sincerely,
> Dmitriy Pavlov
>

[Dmitry Pavlov]

There is nothing wrong with wiki (excepting it is sometimes way too slow
and it may be annoying ).

Github markdown is a way to
1. Keep documenting under version control system
2. Github recommends to provide this doc in the standard place.

Of course, we can move this new doc content to wiki and just provide link
from contributing.md to wiki. Should we?

I can also add a copy to a wiki. Denis, folks,  please share your vision.

чт, 13 дек. 2018 г., 0:32 Denis Magda <[hidden email]>:

> What is wrong with Ignite wiki? It seems like the right place for the doc
> like this.
>
> --
> Denis
>
> On Wed, Dec 12, 2018 at 9:21 AM Dmitriy Pavlov <[hidden email]> wrote:
>
> > Hi Igniters,
> >
> > Just to inform, the very first version of the Contribution step by step
> > guide was added to GitHub. It is one more entry point for newcomers to
> find
> > out what and how should be done to contribute:
> >
> >
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
> >
> >
> > Feel free to share with newcomers and contribute.
> >
> > Sincerely,
> > Dmitriy Pavlov
> >
>

[Ivan Pavlukhin]

Dmitriy,

Thank you for your efforts! For me it looks exactly what is needed.
Screenshot will tell everything for me (see hint at right) [1].

[1] https://gist.githubusercontent.com/pavlukhin/c8c7c6266eeab56048c31f5cdfb31d20/raw/a9af17d920a6eda4328c301023229c2ba6332d58/contr.png
чт, 13 дек. 2018 г. в 01:23, Dmitriy Pavlov <[hidden email]>:

>
> There is nothing wrong with wiki (excepting it is sometimes way too slow
> and it may be annoying ).
>
> Github markdown is a way to
> 1. Keep documenting under version control system
> 2. Github recommends to provide this doc in the standard place.
>
> Of course, we can move this new doc content to wiki and just provide link
> from contributing.md to wiki. Should we?
>
> I can also add a copy to a wiki. Denis, folks,  please share your vision.
>
> чт, 13 дек. 2018 г., 0:32 Denis Magda <[hidden email]>:
>
> > What is wrong with Ignite wiki? It seems like the right place for the doc
> > like this.
> >
> > --
> > Denis
> >
> > On Wed, Dec 12, 2018 at 9:21 AM Dmitriy Pavlov <[hidden email]> wrote:
> >
> > > Hi Igniters,
> > >
> > > Just to inform, the very first version of the Contribution step by step
> > > guide was added to GitHub. It is one more entry point for newcomers to
> > find
> > > out what and how should be done to contribute:
> > >
> > >
> > https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
> > >
> > >
> > > Feel free to share with newcomers and contribute.
> > >
> > > Sincerely,
> > > Dmitriy Pavlov
> > >
> >

--
Best regards,
Ivan Pavlukhin

[Ivan Pavlukhin]

(the link "contributing guidelines" on the screenshot refers to CONTRIBUTING.md)
чт, 13 дек. 2018 г. в 08:50, Павлухин Иван <[hidden email]>:

>
> Dmitriy,
>
> Thank you for your efforts! For me it looks exactly what is needed.
> Screenshot will tell everything for me (see hint at right) [1].
>
> [1] https://gist.githubusercontent.com/pavlukhin/c8c7c6266eeab56048c31f5cdfb31d20/raw/a9af17d920a6eda4328c301023229c2ba6332d58/contr.png
> чт, 13 дек. 2018 г. в 01:23, Dmitriy Pavlov <[hidden email]>:
> >
> > There is nothing wrong with wiki (excepting it is sometimes way too slow
> > and it may be annoying ).
> >
> > Github markdown is a way to
> > 1. Keep documenting under version control system
> > 2. Github recommends to provide this doc in the standard place.
> >
> > Of course, we can move this new doc content to wiki and just provide link
> > from contributing.md to wiki. Should we?
> >
> > I can also add a copy to a wiki. Denis, folks,  please share your vision.
> >
> > чт, 13 дек. 2018 г., 0:32 Denis Magda <[hidden email]>:
> >
> > > What is wrong with Ignite wiki? It seems like the right place for the doc
> > > like this.
> > >
> > > --
> > > Denis
> > >
> > > On Wed, Dec 12, 2018 at 9:21 AM Dmitriy Pavlov <[hidden email]> wrote:
> > >
> > > > Hi Igniters,
> > > >
> > > > Just to inform, the very first version of the Contribution step by step
> > > > guide was added to GitHub. It is one more entry point for newcomers to
> > > find
> > > > out what and how should be done to contribute:
> > > >
> > > >
> > > https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
> > > >
> > > >
> > > > Feel free to share with newcomers and contribute.
> > > >
> > > > Sincerely,
> > > > Dmitriy Pavlov
> > > >
> > >
>
>
>
> --
> Best regards,
> Ivan Pavlukhin

--
Best regards,
Ivan Pavlukhin

[vveider]

There is an error in Build project [1] section.
How can it be fixed? Ticket to IGNITE Jira?


[1] https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#building-project

> On 12 Dec 2018, at 20:21, Dmitriy Pavlov <[hidden email]> wrote:
>
> Hi Igniters,
>
> Just to inform, the very first version of the Contribution step by step
> guide was added to GitHub. It is one more entry point for newcomers to find
> out what and how should be done to contribute:
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
>
>
> Feel free to share with newcomers and contribute.
>
> Sincerely,
> Dmitriy Pavlov

[Dmitry Pavlov]

I'll fix. There is an ignored files list.

чт, 13 дек. 2018 г. в 12:02, Petr Ivanov <[hidden email]>:

> There is an error in Build project [1] section.
> How can it be fixed? Ticket to IGNITE Jira?
>
>
> [1]
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#building-project
>
> > On 12 Dec 2018, at 20:21, Dmitriy Pavlov <[hidden email]> wrote:
> >
> > Hi Igniters,
> >
> > Just to inform, the very first version of the Contribution step by step
> > guide was added to GitHub. It is one more entry point for newcomers to
> find
> > out what and how should be done to contribute:
> >
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
> >
> >
> > Feel free to share with newcomers and contribute.
> >
> > Sincerely,
> > Dmitriy Pavlov
>
>

[dmagda]

The Github page looks like a shorter version of the main wiki page:
https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute

Not sure we want to maintain both. If the wiki source is sluggish and
overloaded then I would rework it instead moving secondary stuff to
sub-pages. Think that the wiki needs the grooming regardless.

--
Denis



On Wed, Dec 12, 2018 at 2:23 PM Dmitriy Pavlov <[hidden email]> wrote:

> There is nothing wrong with wiki (excepting it is sometimes way too slow
> and it may be annoying ).
>
> Github markdown is a way to
> 1. Keep documenting under version control system
> 2. Github recommends to provide this doc in the standard place.
>
> Of course, we can move this new doc content to wiki and just provide link
> from contributing.md to wiki. Should we?
>
> I can also add a copy to a wiki. Denis, folks,  please share your vision.
>
> чт, 13 дек. 2018 г., 0:32 Denis Magda <[hidden email]>:
>
> > What is wrong with Ignite wiki? It seems like the right place for the doc
> > like this.
> >
> > --
> > Denis
> >
> > On Wed, Dec 12, 2018 at 9:21 AM Dmitriy Pavlov <[hidden email]>
> wrote:
> >
> > > Hi Igniters,
> > >
> > > Just to inform, the very first version of the Contribution step by step
> > > guide was added to GitHub. It is one more entry point for newcomers to
> > find
> > > out what and how should be done to contribute:
> > >
> > >
> >
> https://github.com/apache/ignite/blob/master/CONTRIBUTING.md#contributing-to-apache-ignite
> > >
> > >
> > > Feel free to share with newcomers and contribute.
> > >
> > > Sincerely,
> > > Dmitriy Pavlov
> > >
> >
>

[Alexey Kuznetsov]

Hi,

From my experience it is better when all needed stuff available on GitHub.

It is very comfortable when thinks like, "read me", "change log", "how to
build", "how to contribute" and so on available on GitHub.

No need to open some external links.

--
Alexey Kuznetsov

[vveider]

Agree. GitHub can have shorter quick notes with link to full documentation.

> On 14 Dec 2018, at 08:05, Alexey Kuznetsov <[hidden email]> wrote:
>
> Hi,
>
> From my experience it is better when all needed stuff available on GitHub.
>
> It is very comfortable when thinks like, "read me", "change log", "how to
> build", "how to contribute" and so on available on GitHub.
>
> No need to open some external links.
>
> --
> Alexey Kuznetsov

[Dmitry Pavlov]

Thank you for sharing your vision, I also agree to have short in GH and
full in the wiki.

Denis, I see a number of outdated info in How To Contribute, but most
sections there are for a strong reason. A lot of cases covered, and a lot
of cases could be covered in addition to existing.

`Contributing.md` is more not about how to contribute in day by day basis,
but a short step-by-step guide on how to join and start contributing.

Moreover, I would like to refactor website section
https://ignite.apache.org/community/contribute.html#contribute in the same
manner.

пт, 14 дек. 2018 г. в 11:29, Petr Ivanov <[hidden email]>:

> Agree. GitHub can have shorter quick notes with link to full documentation.
>
>
> > On 14 Dec 2018, at 08:05, Alexey Kuznetsov <[hidden email]>
> wrote:
> >
> > Hi,
> >
> > From my experience it is better when all needed stuff available on
> GitHub.
> >
> > It is very comfortable when thinks like, "read me", "change log", "how to
> > build", "how to contribute" and so on available on GitHub.
> >
> > No need to open some external links.
> >
> > --
> > Alexey Kuznetsov
>
>

[dmagda]

>
> `Contributing.md` is more not about how to contribute in day by day basis,
> but a short step-by-step guide on how to join and start contributing.


Could we rework and refine the wiki version in a similar way - most
important stuff first, old is either removed and reworked.

--
Denis

On Fri, Dec 14, 2018 at 2:43 AM Dmitriy Pavlov <[hidden email]> wrote:

> Thank you for sharing your vision, I also agree to have short in GH and
> full in the wiki.
>
> Denis, I see a number of outdated info in How To Contribute, but most
> sections there are for a strong reason. A lot of cases covered, and a lot
> of cases could be covered in addition to existing.
>
> `Contributing.md` is more not about how to contribute in day by day basis,
> but a short step-by-step guide on how to join and start contributing.
>
> Moreover, I would like to refactor website section
> https://ignite.apache.org/community/contribute.html#contribute in the same
> manner.
>
> пт, 14 дек. 2018 г. в 11:29, Petr Ivanov <[hidden email]>:
>
> > Agree. GitHub can have shorter quick notes with link to full
> documentation.
> >
> >
> > > On 14 Dec 2018, at 08:05, Alexey Kuznetsov <[hidden email]>
> > wrote:
> > >
> > > Hi,
> > >
> > > From my experience it is better when all needed stuff available on
> > GitHub.
> > >
> > > It is very comfortable when thinks like, "read me", "change log", "how
> to
> > > build", "how to contribute" and so on available on GitHub.
> > >
> > > No need to open some external links.
> > >
> > > --
> > > Alexey Kuznetsov
> >
> >
>

[Dmitry Pavlov]

Sure,  I will do

пт, 14 дек. 2018 г., 20:37 Denis Magda <[hidden email]>:

> >
> > `Contributing.md` is more not about how to contribute in day by day
> basis,
> > but a short step-by-step guide on how to join and start contributing.
>
>
> Could we rework and refine the wiki version in a similar way - most
> important stuff first, old is either removed and reworked.
>
> --
> Denis
>
> On Fri, Dec 14, 2018 at 2:43 AM Dmitriy Pavlov <[hidden email]> wrote:
>
> > Thank you for sharing your vision, I also agree to have short in GH and
> > full in the wiki.
> >
> > Denis, I see a number of outdated info in How To Contribute, but most
> > sections there are for a strong reason. A lot of cases covered, and a lot
> > of cases could be covered in addition to existing.
> >
> > `Contributing.md` is more not about how to contribute in day by day
> basis,
> > but a short step-by-step guide on how to join and start contributing.
> >
> > Moreover, I would like to refactor website section
> > https://ignite.apache.org/community/contribute.html#contribute in the
> same
> > manner.
> >
> > пт, 14 дек. 2018 г. в 11:29, Petr Ivanov <[hidden email]>:
> >
> > > Agree. GitHub can have shorter quick notes with link to full
> > documentation.
> > >
> > >
> > > > On 14 Dec 2018, at 08:05, Alexey Kuznetsov <[hidden email]>
> > > wrote:
> > > >
> > > > Hi,
> > > >
> > > > From my experience it is better when all needed stuff available on
> > > GitHub.
> > > >
> > > > It is very comfortable when thinks like, "read me", "change log",
> "how
> > to
> > > > build", "how to contribute" and so on available on GitHub.
> > > >
> > > > No need to open some external links.
> > > >
> > > > --
> > > > Alexey Kuznetsov
> > >
> > >
> >
>