Contributing Guide - #3769
Conversation
also add summit video links
t2gran
added
the
!Documentation
| - Tie such series of PRs together with an "epic issue" that explains the overall plan. | ||
| - Use Github issue references ("addresses #12" etc.) to connect PRs and issues together. | ||
| - Consider squashing and rebasing to make the PR history easier to understand, eliminating extra "noise" commits like accidental changes to organization specific code, abandoned experiments, or reverted configuration changes. | ||
| - If possible, please describe your proposed changes in advance before proceeding too far with development. There are often other people working on the same problem. Coordinating with them can avoid a lot of duplicated effort, conflict, and technical debt. |
There was a problem hiding this comment.
I personally think this is the most important thing - so maybe we should put it first. Maybe:
| - If possible, please describe your proposed changes in advance before proceeding too far with development. There are often other people working on the same problem. Coordinating with them can avoid a lot of duplicated effort, conflict, and technical debt. | |
| - If possible, please discuss your proposed changes in advance before proceeding too far with development. There are often other input/angles/thoughts and/or plans on the same problem. Coordinating with other OTP developers can avoid a lot of duplicated effort, conflict, and technical debt and make the review a lot easier. |
There are often other input/angles/thoughts and/or plans on the same problem.
leonardehrenfried
left a comment
leonardehrenfried
left a comment
There was a problem hiding this comment.
This is a good description and explanation of the current development process.
|
|
||
| Any message posted there will be seen by most of the contributors, some of whom work on OTP full time. It will also create a record of the discussion that will be useful to the larger community and often leads to issues being discussed at the twice-weekly development meetings. | ||
|
|
||
| OTP development meetings occur every Tuesday at 10 AM Central European time and Thursday at 15:00 Central European Time on https://meet.google.com/qwh-xzbz-atr. These meetings are open to anyone who wants to join, even if you simply want to observe the process or ask a few questions. The meeting times have been deliberately chosen to allow participation during regular business hours across as many time zones as possible, from the US (east coast) through Europe and Asia. |
There was a problem hiding this comment.
We had a discussion about this yesterday. We will change the meeting link to be always static (currently we have had to use different link if the host is not able to join). It can still be debated if we should define the meeting times in text here and/or use an online calendar that can be updated when, in the rare cases, we have to reschedule a meeting.
There was a problem hiding this comment.
I think this describe the current situation; hence can be merged. When we improve we will of cause update the document. I agree with @optionsome that we should aim for an online calendar (and link to it from here).
There was a problem hiding this comment.
There was a problem hiding this comment.
The ical URL to import the calendar is https://calendar.google.com/calendar/ical/ormbltvsqb6adl80ejgudt0glc@group.calendar.google.com/public/basic.ics
|
Maybe add some sort of code of conduct? https://www.contributor-covenant.org/version/2/1/code_of_conduct/ is one which is extremely commonly used. |
|
|
||
| ## Primary Channels of Communication | ||
|
|
||
| If you have any questions about problems you are encountering with code, deployment, documentation, or development coordination please don't hesitate to post to the OpenTripPlanner discussion groups. These are Google Groups which can be accessed as web forums or as traditional email mailing lists: |
There was a problem hiding this comment.
nit: comma after coordination.
5 participants
This adds a CONTRIBUTING.md and also updates some broken links and outdated information on the History page.