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

Documentation on best practises for contributing #43

Open
TobiBu opened this issue May 24, 2024 · 2 comments
Open

Documentation on best practises for contributing #43

TobiBu opened this issue May 24, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request future Feature that may be implemented in the future, left as a reference.

Comments

@TobiBu
Copy link
Collaborator

TobiBu commented May 24, 2024

Documentation for contributions to RUBIX
For the first public release we should probably have a little section that describes the best practises in software development and how we envision people to contribute to RUBIX. I.e. we should describe the workflow we adopted. First write an issue, then create branch and implement the feature, write tests and ask for pull request. This might help new developers to adopt to our workflow.

Of course, this is not really an urgent item and needs to be in place only for public release.

@MaHaWo @nashmit could you provide some boiler plate text for how you set up the GitHub project and what the SSC recommends in this case?

@TobiBu TobiBu added documentation Improvements or additions to documentation enhancement New feature or request future Feature that may be implemented in the future, left as a reference. labels May 24, 2024
@MaHaWo MaHaWo closed this as completed May 28, 2024
@MaHaWo MaHaWo reopened this May 28, 2024
@MaHaWo
Copy link
Collaborator

MaHaWo commented May 28, 2024

we can of course look into it, but probably only after current sprint. Linking resources for future reference:

@MaHaWo
Copy link
Collaborator

MaHaWo commented May 28, 2024

... also sorry for the accidental close and reopen...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request future Feature that may be implemented in the future, left as a reference.
Projects
None yet
Development

No branches or pull requests

2 participants