In my mind CONTRIBUTING.md is a nice and quite common starting point for contributors. Other projects use it as well [1], [2]. Also GitHub treats it somehow specially, I recall it suggested me to make familiar with CONTRIBUTING.md of some repo.
[1] https://github.com/hazelcast/hazelcast/blob/master/CONTRIBUTING.md [2] https://github.com/apache/cassandra/blob/trunk/CONTRIBUTING.md 2021-03-18 0:32 GMT+03:00, Maxim Muzafarov <mmu...@apache.org>: > Kseniya, > > From my point of view he contribute.html and CONTRIBUTING.md should be > the same with the reference to the wiki page How_to_Contribute_2021 > describing all the additional details and common issues with the first > contributions. > > I also think it would be better to create special dedicated pages for > committers and contributors. I don't get the idea why we can't do this > keeping the same data as they were on the original How_to_Contribute > page. > > On Tue, 16 Mar 2021 at 13:18, Kseniya Romanova > <romanova.ks....@gmail.com> wrote: >> >> So we do have 3 sources for how to contribute: >> >> 1. https://ignite.apache.org/community/contribute.html >> 2. https://github.com/apache/ignite/blob/master/CONTRIBUTING.md >> 3. >> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute+2021 >> >> Seems that wiki is more technical, right? But is there any reason for 2 >> different versions for GitHub and the website? >> >> вт, 16 мар. 2021 г. в 13:11, Ilya Kasnacheev <ilya.kasnach...@gmail.com>: >> >> > Hello again! >> > >> > Based on the feedback, I have removed ASCII art from the git section, >> > making it shorter and clearer. >> > >> > Regards, >> > -- >> > Ilya Kasnacheev >> > >> > >> > вт, 16 мар. 2021 г. в 11:47, Ilya Kasnacheev >> > <ilya.kasnach...@gmail.com>: >> > >> > > Hello, Pavel! >> > > >> > > At the very minimum, a newcomer should be able to run tests on TC or >> > MTCGA. >> > > >> > > Explaining that process takes most of the contribution guide. >> > > >> > > Even if somebody is ready to run those tests for a newcomer once or >> > > twice >> > > (already a long shot, it's hard to even get a simple review), they >> > > have >> > no >> > > opportunity to learn except for this guide. They really don't have >> > anybody >> > > to ask. >> > > >> > > As I have said, I can't create two documents at the same time so if >> > > we >> > > need a separate one for committers, it may only be written after the >> > fact, >> > > and we can't remove essential information in the meantime. >> > > >> > > Regards, >> > > -- >> > > Ilya Kasnacheev >> > > >> > > >> > > пн, 15 мар. 2021 г. в 18:26, Pavel Tupitsyn <ptupit...@apache.org>: >> > > >> > >> Ilya, >> > >> >> > >> Thanks for the effort! >> > >> >> > >> I think this guide should be much shorter and simple. >> > >> Right now it is intimidating for newcomers. >> > >> >> > >> What they need is basically >> > >> * Register in Jira, pick a ticket, assign, put In Progress >> > >> * Create a fork, implement >> > >> * Create a PR >> > >> * Ask for review >> > >> >> > >> Maybe we should have a separate, detailed guide for Committers, >> > >> and a simple one for Contributors? >> > >> >> > >> On Mon, Mar 15, 2021 at 6:19 PM Ilya Kasnacheev < >> > >> ilya.kasnach...@gmail.com> >> > >> wrote: >> > >> >> > >> > Hello! >> > >> > >> > >> > Please see inline. >> > >> > >> > >> > пн, 15 мар. 2021 г. в 18:06, Maxim Muzafarov <mmu...@apache.org>: >> > >> > >> > >> > > Hello, >> > >> > > >> > >> > > >> > >> > > > Ignite employs both Review-Then-Commit processes. >> > >> > > >> > >> > > The Commit-Then-Review (CTR) removed? >> > >> > > >> > >> > I don't see any applications of CTR during the few last years. >> > Streamers >> > >> > were supposed to be CTR but Saikat Maitra still asked for the >> > >> > review >> > of >> > >> > streamers-related commits. >> > >> > >> > >> > > Information for committers >> > >> > > >> > >> > > Do we need this on a page for newcomers? I'd like to mention >> > >> > > that >> > some >> > >> > > of the committers still use the commit script, however, I think >> > >> > > it >> > >> > > will be better to configure the GitHub interaction. >> > >> > > >> > >> > I don't think there's a separate page for committers. If there is, >> > >> please >> > >> > point me to it, and we can remove the section. I don't think we >> > >> > should >> > >> be >> > >> > writing two pages at once, so I decided not to drop any essential >> > >> > information. >> > >> > >> > >> > > Components and their maintainers >> > >> > > >> > >> > > It seems that this list should be updated too. >> > >> > > >> > >> > I would be glad if somebody does it, but I don't have any more >> > >> information >> > >> > to fill there. >> > >> > >> > >> > >> > >> > > > Working on a ticket >> > >> > > I think we should mention the Intellij IDEA checkstyle plugin >> > >> > > and >> > its >> > >> > > configuration (importation of checkstyle.xml to the IDE). >> > >> > > >> > >> > I would be glad if somebody contributes to it, or we may just >> > >> > provide >> > a >> > >> > link to coding guidelines and mention it there. >> > >> > >> > >> > >> > >> > >> > >> > > > GIT workflow >> > >> > > >> > >> > > Do we need it? >> > >> > > >> > >> > I think we do, this workflow is non-trivial and I don't think it >> > >> > is >> > >> > documented anywhere. We can get rid of ASCII art section, though. >> > >> > >> > >> > WDYT? >> > >> > >> > >> > Regards, >> > >> > >> > >> > >> > >> > > >> > >> > > >> > >> > > On Mon, 15 Mar 2021 at 17:25, Ilya Kasnacheev < >> > >> ilya.kasnach...@gmail.com >> > >> > > >> > >> > > wrote: >> > >> > > > >> > >> > > > Hello! >> > >> > > > >> > >> > > > When adding new users to the Contributor role, we usually give >> > them >> > >> a >> > >> > > link >> > >> > > > to "How to Contribute" wiki page. >> > >> > > > >> > >> > > > However, I was feeling that it was in many ways outdated, >> > referring >> > >> to >> > >> > > > outdated development practices and not emphasising TC tests >> > >> > > > and >> > >> MTCGA >> > >> > > bot. >> > >> > > > >> > >> > > > So we took liberty to rewrite this page, meet >> > >> > > > >> > >> > > >> > >> > >> > >> >> > https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute+2021 >> > >> > > > >> > >> > > > We tried to streamline it, make it more friendly to newcomers >> > >> > > > and >> > >> just >> > >> > > > shorter. >> > >> > > > >> > >> > > > Please check it out, share your feelings. >> > >> > > > >> > >> > > > I plan to replace the legacy >> > >> > > > >> > >> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute >> > >> > > with >> > >> > > > this page based on your feedback.. >> > >> > > > >> > >> > > > Regards, >> > >> > > > -- >> > >> > > > Ilya Kasnacheev >> > >> > > >> > >> > >> > >> >> > > >> > > -- Best regards, Ivan Pavlukhin
