[Hacktoberfest] Call for contributions!
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 14
- Forks
- 4
- Avg merge
- 1h 6m
- Merged PRs (30d)
- 2
Description
Do you have some knowledge about research software? We are looking for meaningful contributions to software annotation for Hacktoberfest! For a contribution to be approved for Hacktoberfest you must:
How do I contribute?
Install the Research Software Encyclopedia software with pip
pip install rse
Follow the annotation tutorial on your local machine to complete 25 annotations for software libraries (both criteria and taxonomy). You can then commit to your forked branch, push, and open a pull request for review.
Can I contribute more than once?
You are welcome to submit more than one pull request as long as the 25 are met.
Can I just contribute in the software interface?
You definitely can, but it won't count toward Hacktoberfest. While you can annotate in the web interface provided here, these annotations cannot count toward the PR because they are done on your behalf by a bot.
The maintainers of the RSEPedia have the right to assess the quality of your annotations and determine if they were done with good effort. Please do not submit spam, or otherwise low quality annotations. Thank you!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Install the Research Software Encyclopedia with pip, then follow the linked annotation tutorial on your local machine. Complete 25 software-library annotations covering both criteria and taxonomy, commit them to a forked branch, and open a pull request for maintainer review.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- content
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100