Docs: Update CONTRIBUTING.md #2539
Conversation
Added required details for smooth on-boarding of new contributors.
|
I liked the old tutorial there, that was showing how to contribute a feature into the compiler. I think it is still relevant. |
|
Yes, the tutorial did look good @certik . How do we go about creating one for LPython? |
|
The tutorial can be adapted, but even the one for LFortran is good. It applies for any LCompilers. |
|
@certik I really appreciate and support your idea of keeping the tutorial. I request you to guide me in creating one which is LPython specific. I think it will be a big help to the current and potential contributors. Can we add a separate file for it in the docs and make a reference in the README? I am new to the project and am in the process of understanding the code-base. @Shaikh-Ubaid I request you to guide me in the right direction :) |
doc/src/CONTRIBUTING.md
Outdated
| git add FILE1 (FILE2 ...) | ||
| git commit -m "YOUR_COMMIT_MESSAGE" | ||
| ``` | ||
| We too have day jobs and reviewing a Pull Request (PR) may take some time. We request you to patiently wait for any feedback or action on your PR. If you are asked to make changes, push commits to the same branch to automatically include them in the open PR. |
There was a problem hiding this comment.
Not sure if we need this line.
There was a problem hiding this comment.
I understand your point @Shaikh-Ubaid . I too was hesitant adding this paragraph seeing the sheer amount of students contributing to the project.
Please tell me the changes you recommend. Shall we remove it completely, or make adjustments? Reviewing a PR does take time, right?
There was a problem hiding this comment.
@certik could you share/clarify what should be done here?
|
Since LPython shares it's design with LFortran, the tutorial can work as @certik points out. An LPython specific tutorial can be worked out later. |
|
What is the status of this PR? |
@Thirumalai-Shaktivel I can make an LPython specific tutorial with some guidance, but not currently. It can either be merged as it is, or somebody else can add a tutorial to this PR. |
Added required details for smooth on-boarding of new contributors.