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

Fix broken link in README.md #281

Merged
merged 1 commit into from
Aug 2, 2023
Merged

Conversation

R1j1t
Copy link
Contributor

@R1j1t R1j1t commented Aug 2, 2023

Summary

Custodian documentation link was wrong. Original link was //custodian instead of /custodian.

Also, I am not sure if below is the desired behavior:
image

Let me know if this should be added to this PR?

@shyuep shyuep merged commit 1ffc98a into materialsproject:master Aug 2, 2023
@shyuep
Copy link
Member

shyuep commented Aug 2, 2023

Thanks

@R1j1t
Copy link
Contributor Author

R1j1t commented Aug 2, 2023

Hi @shyuep, thanks for approving the PR!

I want to get involved and contribute to materials project. Would you recommend some issues which I can work on?

@janosh
Copy link
Member

janosh commented Aug 2, 2023

@R1j1t Thanks for offering to help! What code bases would you like to work on/are you most familiar with?

We are always looking to add more tests. Is that sth for you?

Else, we're also in the process of compressing pymatgen test files in materialsproject/pymatgen#3132 which requires fixing some tests that don't work with compressed files yet.

@R1j1t
Copy link
Contributor Author

R1j1t commented Aug 2, 2023

I am currently using pymatgen for grain boundary generation but use ASE for most of my calculations. I plan to shift to pymatgen by end of the year and also setup custodian for my job submission.

So, working on tests would be a good starting point. Let me take a stab at materialsproject/pymatgen#3132! Thanks @janosh for this!

@janosh
Copy link
Member

janosh commented Aug 3, 2023

Maybe materialsproject/pymatgen#3132 is a bad example for getting started considering it's hugely out of date with the master branch.

Honestly any type of testing is helpful and maybe some simple edge case testing would be great. I think parts of pymatgen could be better tested when structures/composition have oxidation states or when optional attributes like Site.label are None. Feel free to jump in anywhere if you can find new edge cases to test.

@R1j1t
Copy link
Contributor Author

R1j1t commented Aug 4, 2023

Thanks so much @janosh. If that is the case, let me go through the the defect analysis(https://github.com/materialsproject/pymatgen-analysis-defects) code base and add test cases!

@janosh
Copy link
Member

janosh commented Aug 4, 2023

I'm sure @jmmshn will be happy to take any test contributions.

@R1j1t R1j1t deleted the bug/readmeLink branch September 6, 2023 03:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants