8000 Contributing · EnCiv/.github Wiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Contributing

David edited this page Jun 18, 2024 · 2 revisions

Before you start coding, please review the React Component guidelines and notes.

If you are not already, get on the slack workspace by filling out this form and then getting the link it provides after submission to go to join slack.

To look for things to work on go to the Project Dashboard. Look for things in the ToDo column, and generally the ones at closer to the top are higher priority but it's not absolute. Also, be careful that some issues may be dependent on other issues being completed - ideally dependent issues are shown.

When you find one that you want to work on, assign it to yourself, or if you do not have permission yet, leave a comment saying you want to take this one.

You are also welcome to ask about issues on slack or the developers meeting. The dev meeting link and announcements are posted in the #developers channel on slack. In many cases the issues may be minimally defined and you are welcome and encouraged to ask for a meeting/discussion about one you are about to start on.

Before you start coding, create a new branch for this issue:

git checkout -b short-issue-text#issue-number

For example point-group#35. The issue text should just be a word or two that make it distinct, and the the issue number. Then when you are ready to create a PR for the issue, or if you just want to push the code so we can talk about it, do:

git push -u origin short-issue-text#issue-number

This will push the code to a new branch on github. (-u means upstream) After this first time, you only need to git push to push updates. After your inital push, go to github and there will be a banner asking you if you want to create a PR for this branch. Go ahead. Also, if you are only pushing this for review, there is a box you can check that says draft, or you can just day Draft in the comment title.

After you have pushed a PR and want a review, go to the Project Dashboard and move the issue into the "Ready for Review" column.

Clone this wiki locally
0