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

docs: description of the project #20

Merged
merged 5 commits into from
Mar 16, 2021
Merged

Conversation

felix-lambert
Copy link
Contributor

@felix-lambert felix-lambert commented Mar 15, 2021

I did'nt go too far because the doc of Julien might be included as a link to this Readme

@felix-lambert felix-lambert self-assigned this Mar 15, 2021
@felix-lambert felix-lambert added the documentation Improvements or additions to documentation label Mar 15, 2021
README.md Outdated

## Contributing

You’re welcome to help ! Please read the [**DisMoi** Contributing Guidelines](https://github.com/dis-moi/backend/blob/master/CONTRIBUTING.md).
Copy link
Member

@lutangar lutangar Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you a create a generic CONTRIBUTING.md as suggested there instead please?
dis-moi/.github#1

I suppose once created, it will be visible on this repository as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I do the same for the backend readme and the extension readme?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you talking about the updates you mades on backend contributing?

About having a generic CONTRIBUTING.md for all repositories I would love to <3
Not sure what's the best way to implements it tho, for example:

  • Shall we have a specific CONTRIBUTING.md in each repository - when required - and link to the generic one?
    Or
  • Shall we leverage the .github mechanism and have the same CONTRIBUTING.md for all repositories and add all the specificities of a project in another md (README.md, suggestions?) file?
    cc @dis-moi/devs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By intuition, I'm more tempted by your second question (.github mechanism)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felix-lambert no need, just for this repo is good!

Copy link
Member

@lutangar lutangar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is far beyond my expectations, loving it!

Could just provide a generic contributing guide? This can be done later tho, I'm approving this 👍

@felix-lambert
Copy link
Contributor Author

Cool for this PR I will not merge before everyone approves :)

Copy link
Contributor

@christpet christpet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work @felix-lambert ! I say merge it :) then we can share with the team!

README.md Outdated Show resolved Hide resolved
@felix-lambert felix-lambert merged commit 2a8a1fb into master Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants