Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Welcome to the Primrose wiki!
Many Areas for Contribution
There is a lot more to successfully building a project than just programming. If you add up all the effort that needs to go into any project, I suspect programming ends up less than 50% of the total. Clearly, the programming is necessary, just not sufficient, for getting the job done. What I think a lot of people miss is that some of the other non-programming tasks are also necessary. To that end, we've put together a document listing (not exhaustively, mind you!) the areas of study in which the project needs help.
How Issues are Organized
You'll see many tags on the issues in the Issues List. The big ones to look out for are:
first-timers-only: Please leave these issues for people just getting started in programming and working with Git, they are simple things more focused on teaching the process of using the various tools. They are usually one-line-of-code changes, with that line completely described within the issue ticket. It will typically be changing a static value of some kind.
easy: Please leave these issues for beginners who have already gotten through the "first timer" process and now need practice writing real code. They will only be a few lines of code to complete the change, and the change will be completely described.
medium: These are real issues that need to be addressed, not just practice issues, where we know that the implementation is straight forward, but it's more effort than the
easyissues that are only a few lines of code. The purpose of the task will be clearly described, and a suggested path for implementation the change will be described, but the step-by-step process of implementing the change will be left to the developer taking on the task.
hard: These are also real issues, but we don't yet know what the implementation will be, as we haven't researched the issue yet.
hardissues are somewhat like TODO items for researching the issue and breaking it down into a series of
If this is your first time here and you're interested in becoming a contributor, please check out Welcome to Primrose.
People who have already installed a text editor, written a small amount of code, and used Git probably want to jump straight to Working on Primrose. There are a number of issues marked
easy waiting for you to get to work.
Finally, if you're confident with your tools and are just looking to jump into the deep end, look at the Project Structure for help in figuring out how all the pieces fit together, and the Project Road Map to get an idea of where things are going. Any issue marked
medium is up for grabs. That's not to say you're not allowed to try to address the
hard issues, just that the
hard issues are marked as such because we haven't yet done the work to figure out what is causing the issue and/or what needs to be done to resolve the issue yet.