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.

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

Improving our contributions document #91

Merged
merged 10 commits into from
Feb 5, 2023
Merged

Conversation

dphfox
Copy link
Owner

@dphfox dphfox commented Dec 7, 2021

See #90 - this PR is all about making our contribution document easier to understand!

@dphfox dphfox added targeting: meta About the Fusion project/maintenance/repo not ready - evaluating Currently gauging feedback and removed not ready - evaluating Currently gauging feedback labels Dec 7, 2021
Copy link
Contributor

@Dionysusnu Dionysusnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with #90 (comment) in that using details is quite bad. Especially the usage of details here is not to provide details but to make headers/sorting. That can be done with exactly that, headers. I assume GitHub supports an index at the top as well? If not, maybe this document could fit in the docs pages.

@dphfox dphfox added the ready to work on Enhancements/changes ready to be made label Feb 1, 2023
@dphfox
Copy link
Owner Author

dphfox commented Feb 1, 2023

Thanks for all of your comments. Combining this feedback with much more of my lived experience working on the 0.2 docs, I've completely redone this document.

Let me know if any issues persist here. I'm trying to get the reading time for contributors down.

Copy link
Contributor

@Dionysusnu Dionysusnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall quite a good rewrite, just got some smaller notes on specific items.
The security-sensitive issue section has disappeared now, though. I think it's worth keeping that in.

@dphfox dphfox linked an issue Feb 5, 2023 that may be closed by this pull request
@dphfox dphfox merged commit 35194d5 into main Feb 5, 2023
@dphfox dphfox deleted the contributions-improvements branch February 5, 2023 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to work on Enhancements/changes ready to be made targeting: meta About the Fusion project/maintenance/repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

We should take a look at our contributions process
3 participants