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

Contributor's documentation #22

Open
11 tasks
szabo137 opened this issue Oct 19, 2023 · 0 comments
Open
11 tasks

Contributor's documentation #22

szabo137 opened this issue Oct 19, 2023 · 0 comments

Comments

@szabo137
Copy link
Member

szabo137 commented Oct 19, 2023 •
edited
Loading

Here we collect ideas for sections to be written for the contributor's documentation.

General purpose

The contribution guide has two main goals:

  • to state the common practice on contributions for QED.jl for all, internal and external, contributors
  • To teach new contributors about the different contribution paths available for QED.jl

Suggested structure
The contribution guide should at least have the following sections

  • code of conduct
  • Get in contact
  • Documentation guide
  • File an issue
  • Code contribution

Included topics

  • advanced installation instructions
  • how-to contribute (git, issues, forks, pull requests)
  • code style guidelines + formatter
  • debugging guide
  • documentation style (docstrings, divio system)
  • review guidelines
  • CI guide
  • API references
  • design patterns
  • testing (how-to write good unit/integration tests, add dev-dependencies to tests)
  • the release workflow (see Release 0.1.5 QEDbase.jl#39 for a blueprint)

References

General

Specifically for GitHub using forks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@szabo137