Phpns (http://phpns.alecwh.com) is a project by Alec Henriksen. The project is licensed under the GNU GPL, as published by the FSF.

phpns

---

---

Contribute to Phpns

This project welcomes all community contribution -- small or large. As of July 2009, we have a more-or-less formal way of accepting patches/changes into our development branch. Please follow this general outline to get the code, make your changes, and give it to us for evalutation.

All changes accepted into the development branch must be reviewed by the project admin. Don't worry though, we just need to check for bugs/security problems.

1. First, register an account on Bitbucket. Bitbucket is the online source code management tool we use--it lets us deal with forks and merges very easily. Registration is relatively painless. You will need to have Mercurial installed as well (the SCM we use).
2. Next, you should probably start following Phpns on our Bitbucket project. This will let you follow along with Phpns commits.
3. Grab the source code with the following command: $ hg clone http://bitbucket.org/alecwh/phpns/. After you have the code, hack away! Do something productive with it--perhaps add a feature you have been wanting? Create a new theme? Improve some of the functions in /inc/function.php? A lot of stuff needs a lot of work!
4. If you need any help with the code, or need help understanding some components, I'm glad to help you. Get ahold of me.
5. All done? Save your changes locally (commit them into hg using hg commit), then you need to officially fork Phpns on Bitbucket. This will basically copy the Phpns repository into a newly created one. Now push your repo to your newly created fork on Bitbucket.
6. After you have finalized your changes (remember, you can make as many changes/commits as you want to your repo), you need to send a pull request to me. Just let me know what you did, how it benefits the development branch, etc.
7. If I like it, and I probably will, your changes will be accepted into the repository (and you will be given credit in the codebase).

For my own sake, I would really appreciate it if you followed that general outline. It makes things a lot easier down the road.

That's it. Have fun. I am very tolerant of emails asking about Phpns development, so don't be afraid to get in touch!

Conventions I appreciate

• Comment your code!
• Please use some sort of indenting technique--I prefer tabs.
• No magic! If something is really difficult to understand, then I'll have trouble fixing it later on, if it needs fixing.

Common commands you may find helpful

To get the Phpns source (and its history)

To commit your changes

To push your changes