Hello! Thank you for considering contributing to PortfoliU Project. It's people like you who make PortfoliU Project a better and better resource.
Following these guidelines helps communicate that you respect the time of the developers managing and maintaining this open-source project. In return, they should reciprocate the same respect in addressing your issue, assessing changes, and helping finalize your pull requests (PRs).
PortfoliU Project is an open-source project and we love receiving contributions from our community, like you! There are many ways you can contribute, from writing tutorials, blog posts, improving documentation, submitting bugs, creating feature requests or even adding templates which can be incorporated into PortfoliU Project itself. You can also contribute by reporting any resources or templates that are not free or open-source, the goal of PortfoliU Project is to have the resources and documentation for you to create a personal portfolio website for free, thus, using free and open-source resources.
Some things we ask.. Please don't use the issue tracker for questions or support. If you have questions or an issue, please try to research the issue online. If that doesn't work, feel free to contact the owner of the repository, Elita Danilyuk.
Responsibilities
- Ensure that your code meets all our requirements: https://github.com/PortfoliU-Project/PortfoliU-Project#contributing-to-the-portfoliu-open-source-github-repository
- Ensure cross-platform compatibility for every change that's accepted.
- Create issues for any major changes and enhancements that you wish to make.
- Discuss things transparently and get community feedback.
- Be welcoming to newcomers and encourage diverse and new contributors from all backgrounds.
Not sure where to start contributing to PortfoliU Project? You can start by loooking through beginner and help-wanted issues.
- Beginner issues are issues that should only require a few lines of code, and a test or two.
- Help wanted issues are issues that may be a bit more involved than beginner issues.
If this is your first time contributing to open-source and you're still unsure where to begin, look into some of these community recommended tutorials / Learning Labs:
- How to Contribute to an Open Source Project on GitHub
- 38m
- GitHub
- Git
- GitHub Skills
- This has various learning labs within it, like Introduction to GitHub and GitHub pages.
Now you're ready to make your changes! Please feel free to ask for help; everyone has been a beginner at first!
Lastly, if a maintainer asks you to 'rebase' your PR, they're saying there's a lot of code that's been changed and that you need to update your branch so it's easier to merge.
- Create your own branch of the code
- Do the changes on your branch
- If you like the change and you think the project can use it:
- Be sure you have commit messages that are clear and concise.
- Be sure you followed the code of conduct and ground rules.
- Create a PR indicating you'd like to your changes to be considered for the project.
This is a new open-source project and we are in the process of creating issue templates for bugs, features, and enhancements.
In general:
-
For bugs, please include:
- A step by step of what you did
- What you saw vs expected to happen
-
For enhancements / features:
- PortfoliU Project's goal is to have useful templates and resources. If you find yourself using another free open source template or other resources that you think the community would like or benefit from, please feel free to create an issue.
- Describe the feature/enhancement you would like to see
- Why you need/want that feature/enhancement
- How that feature/enhancement should work or be added
At this time, the core team is minimal and are current students. This being said, PRs are typically reviewed and given feedback weekly. After feedback is return, we expect responses within a month. After a month, we may close the PR, given it isn't showing any additional activity.