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

Update the contribution guide in the documentation #171

Merged
merged 1 commit into from
Jun 9, 2024
Merged

Update the contribution guide in the documentation #171

merged 1 commit into from
Jun 9, 2024

Conversation

felixchalumeau
Copy link
Collaborator

@felixchalumeau felixchalumeau commented Jan 23, 2024 •
edited
Loading

Related issues: #170

Adding a few sentences to better explain the contribution process. In particular, made it clear that one needs to start by opening a github issue, then fork the repository (unless having permission to branch inside the main project), and request to merge to develop once the contribution is ready.

Checks

  • a clear description of the PR has been added
  • sufficient tests have been written
  • relevant section added to the documentation
  • example notebook added to the repo
  • clean docstrings and comments have been written
  • if any issue/observation has been discovered, a new issue has been opened

Future improvements

n/a

@felixchalumeau felixchalumeau linked an issue Jan 23, 2024 that may be closed by this pull request
Small refinement of the contribution guide #170
Closed
@felixchalumeau felixchalumeau changed the base branch from main to develop January 23, 2024 13:41
@Lookatator Lookatator merged commit fe5c66a into develop Jun 9, 2024
1 check passed
@Lookatator Lookatator mentioned this pull request Jun 10, 2024
Merged
4 tasks
@Lookatator Lookatator deleted the docs/contribution-guide branch September 1, 2024 21:15
Lookatator added a commit that referenced this pull request Sep 6, 2024
@Lookatator @maxencefaldor
@hannah-jan @felixchalumeau
Release 0.4.0 (#183)
8c9d2ec 
* feat(algo): add DCG-MAP-Elites whose most recent version is called DCRL-ME (#167)
* fix: Fix pareto dominance definition to account for solutions which have the same fitness values along one axis (#174)
* docs(contribution): clarify contribution process (#171)
* feat: Upgrade Library Versions and Python Version (#187)

---------

Co-authored-by: Maxence Faldor <m.faldor22@imperial.ac.uk>
Co-authored-by: Hannah Janmohamed <hannah.janmohamed21@imperial.ac.uk>
Co-authored-by: Felix Chalumeau <f.chalumeau@instadeep.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lookatator Lookatator Lookatator approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Small refinement of the contribution guide
2 participants
@felixchalumeau @Lookatator