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

New Developer Checklist [do not close] #918

Open
18 tasks
lifflander opened this issue Jul 10, 2020 · 15 comments
Open
18 tasks

New Developer Checklist [do not close] #918

lifflander opened this issue Jul 10, 2020 · 15 comments

Comments

@lifflander
Copy link
Collaborator

lifflander commented Jul 10, 2020

When a new developer joins the team, this issue provides a checklist to get the new developer setup to work on DARMA codebases. A new developer shall copy this checklist into a comment and make their way down the list.

Sample Checklist:

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++17 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • Build using docker. VT uses docker heavily for CI.
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • Build locally with cmake directly.
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion [YYYY-MM-DD]
Assigned Mentor [mentor-name-goes-here]
Problems/Issues encountered during this process [short-description-of-any-issues-you-encoutered]
GitHub account name [account-handle]

Markdown template to copy for new developers:

- [ ] Copy-paste this list into a comment to check items off the list!
- [ ] Obtain and setup a GitHub account (if you don't have one already)
  - Setup SSH keys for pushing to GitHub
- [ ] Verify familiarity with git (SCM) and configure it properly with proper name and email
- [ ] Setup GPG locally to verify/stamp commits pushed to GitHub
  - Without a proper signature, the repositories are configured to not accept commits
- [ ] Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
- [ ] Obtain access to requisite repositories and organizational pages.
  - For the [public DARMA GitHub](https://github.com/DARMA-tasking), request to be added as a member of the team.
  - If you require access to the [private/internal DARMA GitHub](https://github.com/DARMA-tasking-internal), get added so you can work on internal repositories
  - If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
  - Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
- [ ] Read the [Build Requirements](https://github.com/DARMA-tasking/vt/wiki/Build-Requirements#supported-compilers) page to understand developer requirements
  - Conformation of C++14 standard
  - Supported compilers that must be maintained
  - [Third-Party Libraries (TPLs)](https://github.com/DARMA-tasking/vt/wiki/Third-Party-Libraries-(TPLs)) in VT and requirements and licensing restrictions
- [ ] Read the wiki on our team's [Pull Request Workflow](https://github.com/DARMA-tasking/vt/wiki/Pull-Requests)
  - Ensure you understand the commit message format guidelines
  - Ensure you understand the branch naming and issue creation guidelines
- [ ] Read the [style guidelines](https://github.com/DARMA-tasking/vt/blob/develop/style-guidelines.txt) in the repository for C++ development
- [ ] Read the [Doxygen style guidelines](https://github.com/DARMA-tasking/vt/wiki/Doxygen-Style-Guidelines)
- [ ] Add your name to the list of [Contributors](https://github.com/DARMA-tasking/vt/wiki) on the main wiki page
- [ ] Browse the [main DARMA documentation page](https://darma-tasking.github.io/docs/html/index.html) to understand the high-level goals of DARMA and an [overview of components and features](https://darma-tasking.github.io/docs/html/introduction.html)
- [ ] Locally clone the repositories (e.g., [DARMA/vt](https://github.com/DARMA-tasking/vt), [DARMA/checkpoint](https://github.com/DARMA-tasking/checkpoint), [DARMA/LBAF](https://github.com/DARMA-tasking/LB-analysis-framework), [DARMA/detector](https://github.com/DARMA-tasking/detector)) in DARMA that you will be working on
- [ ] Build and run tests on the VT codebase (and other repositories as appropriate)
  - If you are using `docker`:
    - Download and install `docker` (and `docker-compose` if on Linux separately)
    - Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
    - Build and test VT with `docker-compose` using two different configurations (suggested: *gcc-7*, *clang-4.0*)
  - If you are using `cmake` directly:
    - Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
    - Build and test VT
- [ ] Be assigned a **mentor** that can help with development or help with checking items off this list
- [ ] Ask @lifflander to assign you your first issue (if that hasn't happened already)

| Descriptor | Information |
| --: | -- |
| Date of completion | [YYYY-MM-DD] |
| Assigned Mentor | [mentor-name-goes-here] |
| Problems/Issues encountered during this process | [short-description-of-any-issues-you-encoutered] |
| GitHub account name | [account-handle] |
@cz4rs
Copy link
Contributor

cz4rs commented Jul 10, 2020

  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion 11/07/2020
Assigned Mentor Jonathan @lifflander
Problems/Issues encountered during this process -
GitHub account name @cz4rs

@bradybray
Copy link

bradybray commented Jul 11, 2020

For some clarification; I used capital o (O) to indicate items which could not be completed because the pages, when chosen, came up 404 not found. I suspect those will be filled in the future.

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • [O] Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • [O] Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)

@lifflander
Copy link
Collaborator Author

@bradybray I'm trying to understand why you can't access the contributors page. Do you have access to the GitHub wiki? You are added as a developer so it shouldn't be a problem.

@bradybray
Copy link

@bradybray I'm trying to understand why you can't access the contributors page. Do you have access to the GitHub wiki? You are added as a developer so it shouldn't be a problem.

Yep, you're right. My mistake. I was able to add my name.

@JacobDomagala
Copy link
Contributor

JacobDomagala commented Jul 28, 2020

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion [07/28/2020]
Assigned Mentor Cezary @cz4rs
Problems/Issues encountered during this process -
GitHub account name @JacobDomagala

@cz4rs
Copy link
Contributor

cz4rs commented Aug 13, 2020

@lifflander can you please add Jakub Strzeboński (@jstrzebonski) to DARMA group?

@jstrzebonski
Copy link
Contributor

jstrzebonski commented Aug 13, 2020

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion [18/08/2020]
Assigned Mentor Cezary @cz4rs
Problems/Issues encountered during this process -
GitHub account name @jstrzebonski

@PhilMiller
Copy link
Member

Should we remove new developers as assignees on this issue once we've confirmed they've completed the checklist?

@lifflander
Copy link
Collaborator Author

@PhilMiller Yes, we should be doing that.

@ppebay
Copy link
Contributor

ppebay commented May 28, 2021

PPP's Checklist:

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • Build using docker. VT uses docker heavily for CI.
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • Build locally with cmake directly.
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion [YYYY-MM-DD]
Assigned Mentor [mentor-name-goes-here]
Problems/Issues encountered during this process [short-description-of-any-issues-you-encoutered]
GitHub account name [account-handle]

Markdown template to copy for new developers:

- [ ] Copy-paste this list into a comment to check items off the list!
- [ ] Obtain and setup a GitHub account (if you don't have one already)
  - Setup SSH keys for pushing to GitHub
- [ ] Verify familiarity with git (SCM) and configure it properly with proper name and email
- [ ] Setup GPG locally to verify/stamp commits pushed to GitHub
  - Without a proper signature, the repositories are configured to not accept commits
- [ ] Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
- [ ] Obtain access to requisite repositories and organizational pages.
  - For the [public DARMA GitHub](https://github.com/DARMA-tasking), request to be added as a member of the team.
  - If you require access to the [private/internal DARMA GitHub](https://github.com/DARMA-tasking-internal), get added so you can work on internal repositories
  - If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
  - Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
- [ ] Read the [Build Requirements](https://github.com/DARMA-tasking/vt/wiki/Build-Requirements#supported-compilers) page to understand developer requirements
  - Conformation of C++14 standard
  - Supported compilers that must be maintained
  - [Third-Party Libraries (TPLs)](https://github.com/DARMA-tasking/vt/wiki/Third-Party-Libraries-(TPLs)) in VT and requirements and licensing restrictions
- [ ] Read the wiki on our team's [Pull Request Workflow](https://github.com/DARMA-tasking/vt/wiki/Pull-Requests)
  - Ensure you understand the commit message format guidelines
  - Ensure you understand the branch naming and issue creation guidelines
- [ ] Read the [style guidelines](https://github.com/DARMA-tasking/vt/blob/develop/style-guidelines.txt) in the repository for C++ development
- [ ] Read the [Doxygen style guidelines](https://github.com/DARMA-tasking/vt/wiki/Doxygen-Style-Guidelines)
- [ ] Add your name to the list of [Contributors](https://github.com/DARMA-tasking/vt/wiki) on the main wiki page
- [ ] Browse the [main DARMA documentation page](https://darma-tasking.github.io/docs/html/index.html) to understand the high-level goals of DARMA and an [overview of components and features](https://darma-tasking.github.io/docs/html/introduction.html)
- [ ] Locally clone the repositories (e.g., [DARMA/vt](https://github.com/DARMA-tasking/vt), [DARMA/checkpoint](https://github.com/DARMA-tasking/checkpoint), [DARMA/LBAF](https://github.com/DARMA-tasking/LB-analysis-framework), [DARMA/detector](https://github.com/DARMA-tasking/detector)) in DARMA that you will be working on
- [ ] Build and run tests on the VT codebase (and other repositories as appropriate)
  - If you are using `docker`:
    - Download and install `docker` (and `docker-compose` if on Linux separately)
    - Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
    - Build and test VT with `docker-compose` using two different configurations (suggested: *gcc-7*, *clang-4.0*)
  - If you are using `cmake` directly:
    - Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
    - Build and test VT
- [ ] Be assigned a **mentor** that can help with development or help with checking items off this list
- [ ] Ask @lifflander to assign you your first issue (if that hasn't happened already)

| Descriptor | Information |
| --: | -- |
| Date of completion | [YYYY-MM-DD] |
| Assigned Mentor | [mentor-name-goes-here] |
| Problems/Issues encountered during this process | [short-description-of-any-issues-you-encoutered] |
| GitHub account name | [account-handle] |

@mzuzek
Copy link

mzuzek commented May 28, 2021

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion 2021-05-28
Assigned Mentor @JacobDomagala
Problems/Issues encountered during this process n/a
GitHub account name @MikolajZuzek

@PhilMiller
Copy link
Member

I just noticed - it doesn't look like any learning from the vt tutorial or whatever is included on the checklist, just building and running the code

@stmcgovern
Copy link
Contributor

stmcgovern commented Mar 8, 2022

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion [2022-03-08]
Assigned Mentor [mentor-name-goes-here]
Problems/Issues encountered during this process [short-description-of-any-issues-you-encoutered]
GitHub account name @stmcgovern

@thearusable
Copy link
Contributor

thearusable commented Jun 8, 2022

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion 2022-06-13
Assigned Mentor @JacobDomagala
Problems/Issues encountered during this process N/A
GitHub account name @thearusable

@cwschilly
Copy link
Contributor

cwschilly commented May 30, 2023

  • Copy-paste this list into a comment to check items off the list!
  • Obtain and setup a GitHub account (if you don't have one already)
    • Setup SSH keys for pushing to GitHub
  • Verify familiarity with git (SCM) and configure it properly with proper name and email
  • Setup GPG locally to verify/stamp commits pushed to GitHub
    • Without a proper signature, the repositories are configured to not accept commits
  • Verify familiarity with MPI (baseline knowledge) and scalable development practices for highly concurrent processing
  • Obtain access to requisite repositories and organizational pages.
    • For the public DARMA GitHub, request to be added as a member of the team.
    • If you require access to the private/internal DARMA GitHub, get added so you can work on internal repositories
    • If you require access to a specific application, create a user on that application's SCM and request access. Questions about where application repositories lie and how to access shall be directed toward @lifflander.
    • Access should be requested by emailing @lifflander, who will forward as appropriate depending on who manages each repository
  • Read the Build Requirements page to understand developer requirements
    • Conformation of C++14 standard
    • Supported compilers that must be maintained
    • Third-Party Libraries (TPLs) in VT and requirements and licensing restrictions
  • Read the wiki on our team's Pull Request Workflow
    • Ensure you understand the commit message format guidelines
    • Ensure you understand the branch naming and issue creation guidelines
  • Read the style guidelines in the repository for C++ development
  • Read the Doxygen style guidelines
  • Add your name to the list of Contributors on the main wiki page
  • Browse the main DARMA documentation page to understand the high-level goals of DARMA and an overview of components and features
  • Locally clone the repositories (e.g., DARMA/vt, DARMA/checkpoint, DARMA/LBAF, DARMA/detector) in DARMA that you will be working on
  • Build and run tests on the VT codebase (and other repositories as appropriate)
    • If you are using docker:
      • Download and install docker (and docker-compose if on Linux separately)
      • Configure docker's processor usage levels, number of processors (>=2), memory usage limits, storage usage limits
      • Build and test VT with docker-compose using two different configurations (suggested: gcc-7, clang-4.0)
    • If you are using cmake directly:
      • Obtain all requisite dependencies (MPI, support compiler, etc) on your local machine (or target machine)
      • Build and test VT
  • Be assigned a mentor that can help with development or help with checking items off this list
  • Ask @lifflander to assign you your first issue (if that hasn't happened already)
Descriptor Information
Date of completion 2023-10-01
Assigned Mentor @stmcgovern
Problems/Issues encountered during this process N/A
GitHub account name @cwschilly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests