Create contribution.md #42
Open
+100
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
complete contribution markdown
joelbudu
reviewed
Nov 12, 2024
| pip install . | ||
| ``` | ||
|
|
||
| 3. **Set Up Development Tools (Optional but Recommended):** |
There was a problem hiding this comment.
This bit should be covered by the pyproject.toml and automatically install dev-dependencies. Correct? @Lagyamfi .
I think linting and formatting should be mandatory
contribution.md
Outdated
|
|
||
| 1. **Create a Branch:** | ||
| Create a branch for your work. Use a meaningful name that hints at the purpose (e.g., `feature-enhance-translation`): | ||
| ```bash |
There was a problem hiding this comment.
I'm not sure we need to specify here exactly what git commands to use. It would differ based on the contributors workflow whether terminal or gui based. We can describe here what is expected generally and probably not step by step
There was a problem hiding this comment.
Alright well noted, I will sort that out in a bit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution.md, a standalone markdown file with regular updates as to how to set up and what to do in your editor