Best practices for an open source project

Hi,

This is a general architectural question for best practices. I want to release an open source project, that is geared towards developers. It will be using packagist to package the code for creating projects from the codebase. I am guessing that some users will want to download the repository too.

However, the project will contains things like the GitLab CI file to maintain workflow, building the documentation site on gitlab, functional and unit tests, etc.

Ideally, I do not want to expose these files and information in the composer or git downloads. Is there a best practise way of doing this?

Hi,

This proves best practices and inspires other open source developers to do the same, I wouldn’t hide them unless desired otherwise.

If you want to exclude certain files and folders from a git archive run, you can specify them inside the .gitattributes file in your repository.

Cheers,
Michael

1 Like

Thanks for the response Micheal. That’s a fair point. I may try and leave them exposed, unless I find that it causes an issue with users setting up projects from composer and packagist.

1 Like