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

Add contributing document #150

Closed
lelaus opened this issue Mar 4, 2024 · 4 comments
Closed

Add contributing document #150

lelaus opened this issue Mar 4, 2024 · 4 comments
Assignees
@lelaus
Labels
documentation Improvements or additions to documentation
Milestone
Release of versio...

Comments

@lelaus
Copy link
Collaborator

lelaus commented Mar 4, 2024

To include a contributing document describing how third parties can contribute to the software, report issues/problems with the software and seek support.
A code of conduct document should also be included at the same time.
@lelaus lelaus self-assigned this Mar 4, 2024
lelaus added a commit that referenced this issue Mar 5, 2024
@lelaus
[150_contribution], issue - #150, Added files devoted to contribution…
e8a139e 
… and code of conduct guidelines
@lelaus lelaus mentioned this issue Mar 7, 2024
Closed
@lelaus lelaus added the documentation Improvements or additions to documentation label Mar 7, 2024
@lelaus
Copy link
Collaborator Author

lelaus commented Mar 9, 2024 •
edited
Loading

In the contributing file CONTRIBUTIONS.rst that has been added in commit e8a139e, the reader should be informed that the unittest framework must be used for testing the package.
This request comes from the Community Guidelines section of issue #147.

lelaus added a commit that referenced this issue Mar 17, 2024
@lelaus
[150_contribution], issue - #150, Added to README the reference to th…
2f8d875 
…e contributing document
lelaus added a commit that referenced this issue Mar 17, 2024
@lelaus
[150_contribution], issue - #150, Added how to contribute section in …
815d0a0 
…the doc
lelaus added a commit that referenced this issue Mar 17, 2024
@lelaus
[150_contribution], issue - #150, Added location and framework of tes…
ff4deac 
…ts in the contributing doc
@panDanieleN
Copy link
Collaborator

Merged into master.

No need to update tests.

Modified doc as described by the issue.

@lelaus
Copy link
Collaborator Author

lelaus commented Mar 19, 2024

In README, the link to the "How to Contribute" section does not work. It has to be corrected by adding the ".rst" at the end.

@lelaus lelaus reopened this Mar 19, 2024
lelaus added a commit that referenced this issue Mar 19, 2024
@lelaus
[150_contribution], issue - #150, Corrected the link to the contribut…
9ff7346 
…ing document
@panDanieleN
Copy link
Collaborator

Merged into master.

Updated "Contacts" section of doc.

@lelaus lelaus mentioned this issue Mar 29, 2024
Closed
29 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lelaus lelaus

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Release of version 2.1 after review f...
Development

No branches or pull requests
2 participants
@panDanieleN @lelaus