Just finished configuring your cloud? Great! From this very moment you can start analyzing and improving your code. So, the first thing you need is to create your project. This can be easily done just by clicking New Project button. Then you'll have to enter your project's Name and Key. Try keeping it simple and short, as it will become project's identifier and will refer to all its issues and tasks.
After successful form submitting you'll be taken to Source settings where you need to enter and save your version control system settings, which you also might want to check for correctness. Once they're saved you are ready to move on.
Done with basic project settings? Then you'll probably need to create the first snapshot. To make things easier we made this feature available from your project's preview on the main Projects page, and from Issues and Code Review pages. So feel free to click, yet keep in mind that taking snapshot could be a time consuming process and it totally depends on your project's size and complexity.
Issues and Tasks
Snapshot's done cooking? Well, now you can see all the issues found in your code. Don't get sad if their number is huge as you can start fixing them from this very moment! First you can see issue's details by clicking on it in the Issues list - this action will reveal Issue view panel. Then you can create task for this issue: select this option from the dropdown menu or check issue in the list, so Create task button will appear on top of the panel. Simple as that!
All your created tasks will be kept on the Tasks page so you can access them easily. Still all the actions referred to tasks will be available both from Tasks and Issues pages.
Once we loaded you with few thousands of issues you still can decide that it's not enough. Ok then, all you need is to go to Project > Code Review page. Here you can view source code with all the issues we already found for it. Also we provided you with statistics and metrics with improvement recommendations for each code element that we mindfully placed in the tabs where you can find it. Now you can select source code parts you find problematic and Create task by clicking button on the top panel. In the same way you can create tasks for issues listed in the Issues panel.
Once you've created task or just noticed tricky issue, you might want to track its resolving process with Jira issue tracking system. For making this possible you need to select this option from the issue dropdown menu.
Then you'll have to enter your Jira URL and credentials in the evoked pop-up window and click the Check button so we make sure everything is correct. After that you'll get list of all Jira projects you are assigned to so you could choose one of them to import task into. Notice, that after sending task to Jira you won't have possibility to edit it in codeNforcer.
Also Jira settings are always available on the Project settings page where you can perform the above described actions.
Probably you can find that default Validations, Conventions and User Rules we provided you with don't actually fit your requirements. Still it's not a problem as you always can create and manage your own settings. For this purpose visit Project > Project settings > Validations / Conventions / User Rules tabs where you can clone default checks, name them and then edit as your wish.
All the checks you create will become available for all the rest of your projects, so you won't need to do the same job creating them twice.
Also turning off checks is possible from the Issues page by clicking Turn off icon on the one you don't need. Yet notice, that you can't turn off them for default checks set.
Code Quality configuration
Same as for Validations, Conventions and User Rules you can adjust given Code Quality characteristics to your requirements. Well, you can't add extra characteristics but you can turn them on and off from Project > Project settings > Code Quality tab.
Also it is possible to turn them off from Issues page by clicking Turn off icon on the one you don't need.
Are you a person that sticks to the plan? We bet you are! So you'll like our Quality Target Point feature, or simply QTP. With its help you can create a plan of how you expect your project's code quality must advance. This can be done on the project's QTP page. Here you can set Quality Target Points - levels that your code's quality should reach by selected date. So click New QTP button, enter preferred name and date and set expected metrics values. We don't bind you, you are free to create as many QTPs as you wish to fulfill your needs.
Then each QTP will be compared to actual value of closest snapshot, so you'll see two trends: Expected QTPs and Actual ones. In addition there's Round QTP chart, that describes metrics and checks average values for the latest snapshot.
Notice, that you can edit whole QTP or its separate values only until it's not compared with snapshot values.
Love keeping everything under control? Or on the contrary you're just tired of dozens notifications you receive in your mailbox every day? We can help you both ways. Just go to top menu: My Profile > Project settings. Here is the place where you can manage notifications from codeNforcer just by selecting preferred options.
Users and Roles
Can't manage all your projects by yourself? That's ok, as you can always invite the whole crew to your cloud and assign them to different projects without any restrictions. Users Module is accessible from top menu: Account > Users. From here you can Invite bunch of new users just by entering their email addresses. They will receive invitation email and then register in your cloud . On the other hand you can Add new user by filling offered form.
Notice, that you can manage new user's access to different cloud modules by assigning Roles to them. We've provided you with three default Roles, but if that's not enough, feel free to create and manage new ones in the Roles Module, which you can find in top menu: Settings > Roles.
Added dozens of developers to the cloud and don't know what to do next? Assign them to your projects! To make it done go to the Project > Project settings > Access tab and just start typing their names in the provided fields. But in prior, please, make sure that all the users you are going to add to the project have Roles that grant access to Projects Module.
For each added user you can set permissions:
- Developers - have Read access to the project and can manage tasks assigned to them.
- Managers - have Read and Write access, so they can create snapshots, tasks and do the whole project management thing.
- Administrators - can do all the above listed and edit project settings.
If you are dealing with some extremely important or top secret projects, or you are just a bit paranoid, you can encrypt your source code and be the only person to read it. This feature can be reached from top menu: Settings > Source code encryption. Here you can turn on switcher and add password. Don't forget it as from now every time you'll try to access source code (eg. from Code Review or Task view pages) you'll be prompted to enter it.
We have to warn you that switching on/off encryption or changing the password will make impossible to get the source code from snapshots made prior to this change.