search

moja-global / About_moja_global

About moja global and How We Work
Mozilla Public License 2.0
35 stars 33 forks source link

Naming Convention for the Repositories #41

Open gmajan opened 4 years ago

gmajan commented 4 years ago

What does the current documentation state? We are using an unwritten naming convention for the repositories. As far as I know, we use . to indicate a sort of sub-directory and _ to connect words of 1 title. The top directory indicates the initiative the directory is under: e.g. GSoC so people know that adding to these repos might interfere with deliverables. If there is no initiative, then the repo is operational and thus open. The second layer is the tool the repo is under. FLINT for most repos but not all. Next is the name of the repo

If this is indeed how we work, it would be good to document this and make sure the existing names are in line.

Where is this stated? Nowhere yet

Why do you want to improve the statement? If we have a clear naming system, contributors feel at ease to make new repos and they can quickly understand what repos are for.

Proposed statement Follow an agreed naming system

Additional info None

Patamap commented 4 years ago

Set a meaningful name:

  1. Try to make purpose obvious in title 2 Use hyphens (-) instead of underscores (_) For ex. FLINT-Grassland-carbon-models GSoC-FLINT-Agricultural-Soil-Model Country-mapping-project
  2. Write a description: Write one or two sentences to quickly describe the project. (1repo has only 1 project in order to view all issues/new idea there)
Patamap commented 4 years ago

@gmajan @Tlazypanda this issue becomes a high priority due to creating more on the new repo nowadays. May I have your comment on the proposal, please?

gmajan commented 4 years ago

@Patamap When the title contains a dot (.) it is like a / in a regular file name: i.e. it is a different sub-division. Between the dots, the words are separated by underscores. Why do you want to get rid of the dots and underscores? Thank you. :)

Patamap commented 4 years ago

@gmajan thanks for your feedback. It is ok to have . and - as we agreed to choose what we want to have it together. Not missing up.

Patamap commented 4 years ago

UPDATE:

We ran through this name conversational together in a call yesterday.
The conventional rules are

  1. The Software name is the first and big capital.
    For example, FLINT, GCBM.
  2. The Subdirector will be after the software name and big capital for the first character. For example, FLINT.Module.
  3. The same name, _ will be used.
    For example, FLINT.Module.Forest_biomass_model.
  4. Program is the first name in repo, if available
    For example LEMP.GCBM.Module.Environmentally_sensitive_forest_module for Linux program. Google_Summer_of_Code for google program.
  5. Try to make purpose obvious in title. For example. GCBM.Chile.Data_Preprocessing

NEXT

These rules will be written in the github workflow and if anyone has the question or propose, a new issue can be raised for discussion.

gmajan commented 3 years ago

@all-contributors please add @jenkatesmits for data

allcontributors[bot] commented 3 years ago

@gmajan

I couldn't determine any contributions to add, did you specify any contributions? Please make sure to use valid contribution names.

gmajan commented 3 years ago

@all-contributors please add @jenkatesmits for data

allcontributors[bot] commented 3 years ago

@gmajan

I couldn't determine any contributions to add, did you specify any contributions? Please make sure to use valid contribution names.

gmajan commented 3 years ago

@all-contributors please add @jenkatesmits for documentation

allcontributors[bot] commented 3 years ago

@gmajan

I've put up a pull request to add @jenkatesmits! :tada: