Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc]: Simplify the contributing guide #590

Closed
tomvothecoder opened this issue Jan 19, 2024 · 0 comments · Fixed by #593
Closed

[Doc]: Simplify the contributing guide #590

tomvothecoder opened this issue Jan 19, 2024 · 0 comments · Fixed by #593
Assignees
@tomvothecoder
Labels
good-first-issue Good first issue for new contributors type: docs Updates to documentation
Milestone
FY24Q3 (4/01/24 -...

Comments

@tomvothecoder
Copy link
Collaborator

Describe your documentation update

The contributing guide that I wrote awhile back is pretty lengthy and can be unnecessarily technical for new contributors. This might deter people from wanting to contribute to xCDAT.

We should aim to:

  • Make getting started simple (e.g., repo and environment setup)
  • Make requirements a bit more flexible (e.g., fork vs. write access)
  • Make it easy to use pre-commit and CI/CD tools
@tomvothecoder tomvothecoder self-assigned this Jan 19, 2024
@tomvothecoder tomvothecoder mentioned this issue Jan 30, 2024
Merged
27 tasks
@tomvothecoder tomvothecoder moved this from Todo to In Progress in xCDAT Development Jan 31, 2024
@tomvothecoder tomvothecoder added type: docs Updates to documentation and removed type: documentation labels Jan 31, 2024
@tomvothecoder tomvothecoder moved this from In Progress to In Review in xCDAT Development Feb 12, 2024
@tomvothecoder tomvothecoder moved this from In Review to Pull Requests in xCDAT Development Feb 12, 2024
@tomvothecoder tomvothecoder moved this from Pull Requests to In Review in xCDAT Development Feb 12, 2024
@tomvothecoder tomvothecoder added the good-first-issue Good first issue for new contributors label Jun 5, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in xCDAT Development Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomvothecoder tomvothecoder

Labels
good-first-issue Good first issue for new contributors type: docs Updates to documentation
Projects
xCDAT Development
Status: Done
Milestone
FY24Q3 (4/01/24 - 06/30/24)
Development

Successfully merging a pull request may close this issue.

[PR]: Simplify the contributing guide xCDAT/xcdat
1 participant
@tomvothecoder