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

Add wiki entry "how to add a new contributer (first steps)" #1094

Closed
1 task done
stap-m opened this issue Apr 1, 2022 · 6 comments
Closed
1 task done

Add wiki entry "how to add a new contributer (first steps)" #1094

stap-m opened this issue Apr 1, 2022 · 6 comments
Labels
organisation Concerning the repository and GitHub related tasks stale already discussed issues that haven't got worked on for a while wiki about adding or editing the wiki

Comments

@stap-m
Copy link
Contributor

stap-m commented Apr 1, 2022

Description of the issue

Adding oneself as contributor to the OEO is often one of the first GitHub steps new oeo developers take and should be documented in the wiki.

Ideas of solution

Include description as subsection in the wiki article on how to participate.

Workflow checklist

  • I am aware of the workflow for this repository
@stap-m stap-m added the To do Issues that haven't got discussed yet label Apr 1, 2022
@stap-m stap-m added wiki about adding or editing the wiki organisation Concerning the repository and GitHub related tasks labels Apr 1, 2022
@markus-rothkoetter
Copy link
Contributor

I'm currently in the process of trying to add myself.
So, I'll note down the exact steps and can provide a proposal for a wiki entry afterwards.

I think the cloning step discussed in #1096 has to be part of the guide.
(#1096 (comment))

Shall each new contributor create an issue in order to obtain a "feature number" for the branch they're creating to add themselves? (Otherwise the branch won't adhere the naming convention)
How shall contributors name their branch otherwise?

@l-emele
Copy link
Contributor

l-emele commented Apr 1, 2022

Often, the addition of a new user is together with implementing something. Only if a user is added without implementing at the same time, the problem you described arises. I see two possible solutions:

  • Either create an issue and branch containing the issue number
  • Or create a branch without issue number. Something like feature-new-user-[username]

@stap-m
Copy link
Contributor Author

stap-m commented Apr 3, 2022

See also #1096 (comment)

@github-actions github-actions bot removed the To do Issues that haven't got discussed yet label Apr 3, 2022
@markus-rothkoetter
Copy link
Contributor

* Either create an issue and branch containing the issue number

* Or create a branch without issue number. Something like `feature-new-user-[username]`

I'd opt for the later, as ...

  • it's adhering to the standard convention (less things to think about for newbies like me)
  • allows to "allocate" a user-id in case of simultaneous joins. (like it was happening with now)
  • one can set-up the working environment fully prior starting to work

@markus-rothkoetter
Copy link
Contributor

This is my rough outline of the steps needed to add oneself as a contributor:

  1. Get added to the organisation by one of the maintainers
    (like noted in Add new user #1096)
  2. Clone the ontology
  3. Check for the next available user-id, check:
  • open issues
  • pending pull-requests
  • oeo.omn file at dc:contributor
  1. create issue Add new contributor/user 0000
  2. create new branch from dev named according to Git-convention
  3. Open either ...
  • ... Protégé or

  • ... texteditor editing the oeo.omn

  1. Add yourself as a contributor with the annotation pattern:
    0000 FirstName LastName (@GitHub-username)
  2. Commit change
  3. Push your change
  4. Create a pull-request

You obtained a contributor/user-id now, but still have to adjust your Protege settings to numerical identifers (linking to other guide)

Concerning step 1 shall there be a default team-member to adress?

Did I miss anything important?
If not, I'm going to compose a wiki-entry.

@stale stale bot added the stale already discussed issues that haven't got worked on for a while label Apr 19, 2022
@markus-rothkoetter
Copy link
Contributor

After having added this to the wiki, I'll close this.
For further comments refer to #1106

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
organisation Concerning the repository and GitHub related tasks stale already discussed issues that haven't got worked on for a while wiki about adding or editing the wiki
Projects
None yet
Development

No branches or pull requests

3 participants